@aws-sdk/client-securityhub 3.316.0 → 3.319.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +12 -0
- package/dist-types/commands/BatchDisableStandardsCommand.d.ts +25 -0
- package/dist-types/commands/BatchEnableStandardsCommand.d.ts +27 -0
- package/dist-types/commands/BatchImportFindingsCommand.d.ts +47 -0
- package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +60 -0
- package/dist-types/commands/CreateActionTargetCommand.d.ts +18 -0
- package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +26 -0
- package/dist-types/commands/CreateInsightCommand.d.ts +31 -0
- package/dist-types/commands/CreateMembersCommand.d.ts +23 -0
- package/dist-types/commands/DeclineInvitationsCommand.d.ts +19 -0
- package/dist-types/commands/DeleteActionTargetCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +11 -0
- package/dist-types/commands/DeleteInsightCommand.d.ts +16 -0
- package/dist-types/commands/DeleteInvitationsCommand.d.ts +18 -0
- package/dist-types/commands/DeleteMembersCommand.d.ts +19 -0
- package/dist-types/commands/DescribeActionTargetsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeHubCommand.d.ts +19 -0
- package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/DescribeProductsCommand.d.ts +39 -0
- package/dist-types/commands/DescribeStandardsCommand.d.ts +39 -0
- package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +46 -0
- package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +11 -0
- package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +11 -0
- package/dist-types/commands/DisableSecurityHubCommand.d.ts +9 -0
- package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +9 -0
- package/dist-types/commands/DisassociateMembersCommand.d.ts +14 -0
- package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +16 -0
- package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +11 -0
- package/dist-types/commands/EnableSecurityHubCommand.d.ts +14 -0
- package/dist-types/commands/GetAdministratorAccountCommand.d.ts +19 -0
- package/dist-types/commands/GetEnabledStandardsCommand.d.ts +25 -0
- package/dist-types/commands/GetFindingAggregatorCommand.d.ts +22 -0
- package/dist-types/commands/GetFindingsCommand.d.ts +111 -0
- package/dist-types/commands/GetInsightResultsCommand.d.ts +29 -0
- package/dist-types/commands/GetInsightsCommand.d.ts +38 -0
- package/dist-types/commands/GetInvitationsCountCommand.d.ts +16 -0
- package/dist-types/commands/GetMembersCommand.d.ts +37 -0
- package/dist-types/commands/InviteMembersCommand.d.ts +19 -0
- package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +17 -0
- package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +18 -0
- package/dist-types/commands/ListInvitationsCommand.d.ts +21 -0
- package/dist-types/commands/ListMembersCommand.d.ts +31 -0
- package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +21 -0
- package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +44 -0
- package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +44 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +19 -0
- package/dist-types/commands/TagResourceCommand.d.ts +15 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
- package/dist-types/commands/UpdateActionTargetCommand.d.ts +13 -0
- package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +27 -0
- package/dist-types/commands/UpdateInsightCommand.d.ts +26 -0
- package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +11 -0
- package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +12 -0
- package/dist-types/commands/UpdateStandardsControlCommand.d.ts +13 -0
- package/package.json +5 -5
|
@@ -57,6 +57,52 @@ export interface DescribeStandardsControlsCommandOutput extends DescribeStandard
|
|
|
57
57
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
58
58
|
*
|
|
59
59
|
*
|
|
60
|
+
* @example To get a list of controls for a security standard
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // The following example returns a list of security controls and control details that apply to a specified security standard. The list includes controls that are enabled and disabled in the standard.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "MaxResults": 2,
|
|
65
|
+
* "NextToken": "NULL",
|
|
66
|
+
* "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
|
|
67
|
+
* };
|
|
68
|
+
* const command = new DescribeStandardsControlsCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* /* response ==
|
|
71
|
+
* {
|
|
72
|
+
* "Controls": [
|
|
73
|
+
* {
|
|
74
|
+
* "ControlId": "PCI.AutoScaling.1",
|
|
75
|
+
* "ControlStatus": "ENABLED",
|
|
76
|
+
* "ControlStatusUpdatedAt": "2020-05-15T18:49:04.473000+00:00",
|
|
77
|
+
* "Description": "This AWS control checks whether your Auto Scaling groups that are associated with a load balancer are using Elastic Load Balancing health checks.",
|
|
78
|
+
* "RelatedRequirements": [
|
|
79
|
+
* "PCI DSS 2.2"
|
|
80
|
+
* ],
|
|
81
|
+
* "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/PCI.AutoScaling.1/remediation",
|
|
82
|
+
* "SeverityRating": "LOW",
|
|
83
|
+
* "StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1",
|
|
84
|
+
* "Title": "Auto scaling groups associated with a load balancer should use health checks"
|
|
85
|
+
* },
|
|
86
|
+
* {
|
|
87
|
+
* "ControlId": "PCI.CW.1",
|
|
88
|
+
* "ControlStatus": "ENABLED",
|
|
89
|
+
* "ControlStatusUpdatedAt": "2020-05-15T18:49:04.498000+00:00",
|
|
90
|
+
* "Description": "This control checks for the CloudWatch metric filters using the following pattern { $.userIdentity.type = \"Root\" && $.userIdentity.invokedBy NOT EXISTS && $.eventType != \"AwsServiceEvent\" } It checks that the log group name is configured for use with active multi-region CloudTrail, that there is at least one Event Selector for a Trail with IncludeManagementEvents set to true and ReadWriteType set to All, and that there is at least one active subscriber to an SNS topic associated with the alarm.",
|
|
91
|
+
* "RelatedRequirements": [
|
|
92
|
+
* "PCI DSS 7.2.1"
|
|
93
|
+
* ],
|
|
94
|
+
* "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/PCI.CW.1/remediation",
|
|
95
|
+
* "SeverityRating": "MEDIUM",
|
|
96
|
+
* "StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.CW.1",
|
|
97
|
+
* "Title": "A log metric filter and alarm should exist for usage of the \"root\" user"
|
|
98
|
+
* }
|
|
99
|
+
* ],
|
|
100
|
+
* "NextToken": "U2FsdGVkX1+eNkPoZHVl11ip5HUYQPWSWZGmftcmJiHL8JoKEsCDuaKayiPDyLK+LiTkShveoOdvfxXCkOBaGhohIXhsIedN+LSjQV/l7kfCfJcq4PziNC1N9xe9aq2pjlLVZnznTfSImrodT5bRNHe4fELCQq/z+5ka+5Lzmc11axcwTd5lKgQyQqmUVoeriHZhyIiBgWKf7oNYdBVG8OEortVWvSkoUTt+B2ThcnC7l43kI0UNxlkZ6sc64AsW"
|
|
101
|
+
* }
|
|
102
|
+
* *\/
|
|
103
|
+
* // example id: to-get-a-list-of-controls-for-a-security-standard-1676308027759
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
60
106
|
*/
|
|
61
107
|
export declare class DescribeStandardsControlsCommand extends $Command<DescribeStandardsControlsCommandInput, DescribeStandardsControlsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
62
108
|
readonly input: DescribeStandardsControlsCommandInput;
|
|
@@ -58,6 +58,17 @@ export interface DisableImportFindingsForProductCommandOutput extends DisableImp
|
|
|
58
58
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
59
59
|
*
|
|
60
60
|
*
|
|
61
|
+
* @example To end a Security Hub integration
|
|
62
|
+
* ```javascript
|
|
63
|
+
* // The following example ends an integration between Security Hub and the specified product that sends findings to Security Hub. After the integration ends, the product no longer sends findings to Security Hub.
|
|
64
|
+
* const input = {
|
|
65
|
+
* "ProductSubscriptionArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"
|
|
66
|
+
* };
|
|
67
|
+
* const command = new DisableImportFindingsForProductCommand(input);
|
|
68
|
+
* await client.send(command);
|
|
69
|
+
* // example id: to-end-a-security-hub-integration-1676480035650
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
61
72
|
*/
|
|
62
73
|
export declare class DisableImportFindingsForProductCommand extends $Command<DisableImportFindingsForProductCommandInput, DisableImportFindingsForProductCommandOutput, SecurityHubClientResolvedConfig> {
|
|
63
74
|
readonly input: DisableImportFindingsForProductCommandInput;
|
|
@@ -55,6 +55,17 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
|
|
|
55
55
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
56
56
|
*
|
|
57
57
|
*
|
|
58
|
+
* @example To remove a Security Hub administrator account
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // The following example removes the Security Hub administrator account in the Region from which the operation was executed. This operation doesn't remove the delegated administrator account in AWS Organizations.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "AdminAccountId": "123456789012"
|
|
63
|
+
* };
|
|
64
|
+
* const command = new DisableOrganizationAdminAccountCommand(input);
|
|
65
|
+
* await client.send(command);
|
|
66
|
+
* // example id: to-remove-a-security-hub-administrator-account-1676480521876
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
58
69
|
*/
|
|
59
70
|
export declare class DisableOrganizationAdminAccountCommand extends $Command<DisableOrganizationAdminAccountCommandInput, DisableOrganizationAdminAccountCommandOutput, SecurityHubClientResolvedConfig> {
|
|
60
71
|
readonly input: DisableOrganizationAdminAccountCommandInput;
|
|
@@ -59,6 +59,15 @@ export interface DisableSecurityHubCommandOutput extends DisableSecurityHubRespo
|
|
|
59
59
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
+
* @example To deactivate Security Hub
|
|
63
|
+
* ```javascript
|
|
64
|
+
* // The following example deactivates Security Hub for the current account and Region.
|
|
65
|
+
* const input = undefined;
|
|
66
|
+
* const command = new DisableSecurityHubCommand(input);
|
|
67
|
+
* await client.send(command);
|
|
68
|
+
* // example id: to-deactivate-security-hub-1676583894245
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
62
71
|
*/
|
|
63
72
|
export declare class DisableSecurityHubCommand extends $Command<DisableSecurityHubCommandInput, DisableSecurityHubCommandOutput, SecurityHubClientResolvedConfig> {
|
|
64
73
|
readonly input: DisableSecurityHubCommandInput;
|
|
@@ -59,6 +59,15 @@ export interface DisassociateFromAdministratorAccountCommandOutput extends Disas
|
|
|
59
59
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
+
* @example To disassociate requesting account from administrator account
|
|
63
|
+
* ```javascript
|
|
64
|
+
* // The following example dissociates the requesting account from its associated administrator account.
|
|
65
|
+
* const input = undefined;
|
|
66
|
+
* const command = new DisassociateFromAdministratorAccountCommand(input);
|
|
67
|
+
* await client.send(command);
|
|
68
|
+
* // example id: to-disassociate-requesting-account-from-administrator-account-1676584168509
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
62
71
|
*/
|
|
63
72
|
export declare class DisassociateFromAdministratorAccountCommand extends $Command<DisassociateFromAdministratorAccountCommandInput, DisassociateFromAdministratorAccountCommandOutput, SecurityHubClientResolvedConfig> {
|
|
64
73
|
readonly input: DisassociateFromAdministratorAccountCommandInput;
|
|
@@ -61,6 +61,20 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
|
|
|
61
61
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
62
62
|
*
|
|
63
63
|
*
|
|
64
|
+
* @example To disassociate member accounts from administrator account
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // The following example dissociates the specified member accounts from the associated administrator account.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "AccountIds": [
|
|
69
|
+
* "123456789012",
|
|
70
|
+
* "111122223333"
|
|
71
|
+
* ]
|
|
72
|
+
* };
|
|
73
|
+
* const command = new DisassociateMembersCommand(input);
|
|
74
|
+
* await client.send(command);
|
|
75
|
+
* // example id: to-disassociate-member-accounts-from-administrator-account-1676918349164
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
64
78
|
*/
|
|
65
79
|
export declare class DisassociateMembersCommand extends $Command<DisassociateMembersCommandInput, DisassociateMembersCommandOutput, SecurityHubClientResolvedConfig> {
|
|
66
80
|
readonly input: DisassociateMembersCommandInput;
|
|
@@ -60,6 +60,22 @@ export interface EnableImportFindingsForProductCommandOutput extends EnableImpor
|
|
|
60
60
|
* <p>The resource specified in the request conflicts with an existing resource.</p>
|
|
61
61
|
*
|
|
62
62
|
*
|
|
63
|
+
* @example To activate an integration
|
|
64
|
+
* ```javascript
|
|
65
|
+
* // The following example activates an integration between Security Hub and a third party partner product that sends findings to Security Hub.
|
|
66
|
+
* const input = {
|
|
67
|
+
* "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"
|
|
68
|
+
* };
|
|
69
|
+
* const command = new EnableImportFindingsForProductCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* /* response ==
|
|
72
|
+
* {
|
|
73
|
+
* "ProductSubscriptionArn": "arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon"
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-activate-an-integration-1676918918114
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
63
79
|
*/
|
|
64
80
|
export declare class EnableImportFindingsForProductCommand extends $Command<EnableImportFindingsForProductCommandInput, EnableImportFindingsForProductCommandOutput, SecurityHubClientResolvedConfig> {
|
|
65
81
|
readonly input: EnableImportFindingsForProductCommandInput;
|
|
@@ -55,6 +55,17 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
|
|
|
55
55
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
56
56
|
*
|
|
57
57
|
*
|
|
58
|
+
* @example To designate a Security Hub administrator
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "AdminAccountId": "123456789012"
|
|
63
|
+
* };
|
|
64
|
+
* const command = new EnableOrganizationAdminAccountCommand(input);
|
|
65
|
+
* await client.send(command);
|
|
66
|
+
* // example id: to-designate-a-security-hub-administrator-1676998319851
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
58
69
|
*/
|
|
59
70
|
export declare class EnableOrganizationAdminAccountCommand extends $Command<EnableOrganizationAdminAccountCommandInput, EnableOrganizationAdminAccountCommandOutput, SecurityHubClientResolvedConfig> {
|
|
60
71
|
readonly input: EnableOrganizationAdminAccountCommandInput;
|
|
@@ -79,6 +79,20 @@ export interface EnableSecurityHubCommandOutput extends EnableSecurityHubRespons
|
|
|
79
79
|
* <p>The resource specified in the request conflicts with an existing resource.</p>
|
|
80
80
|
*
|
|
81
81
|
*
|
|
82
|
+
* @example To activate Security Hub
|
|
83
|
+
* ```javascript
|
|
84
|
+
* // The following example activates the Security Hub service in the requesting AWS account. The service is activated in the current AWS Region or the Region that you specify in the request. Some standards are automatically turned on in your account unless you opt out. To determine which standards are automatically turned on, see the Security Hub documentation.
|
|
85
|
+
* const input = {
|
|
86
|
+
* "EnableDefaultStandards": true,
|
|
87
|
+
* "Tags": {
|
|
88
|
+
* "Department": "Security"
|
|
89
|
+
* }
|
|
90
|
+
* };
|
|
91
|
+
* const command = new EnableSecurityHubCommand(input);
|
|
92
|
+
* await client.send(command);
|
|
93
|
+
* // example id: to-activate-security-hub-1676998538599
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
82
96
|
*/
|
|
83
97
|
export declare class EnableSecurityHubCommand extends $Command<EnableSecurityHubCommandInput, EnableSecurityHubCommandOutput, SecurityHubClientResolvedConfig> {
|
|
84
98
|
readonly input: EnableSecurityHubCommandInput;
|
|
@@ -57,6 +57,25 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
|
|
|
57
57
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
58
58
|
*
|
|
59
59
|
*
|
|
60
|
+
* @example To get details about the Security Hub administrator account
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // The following example provides details about the Security Hub administrator account for the requesting member account.
|
|
63
|
+
* const input = undefined;
|
|
64
|
+
* const command = new GetAdministratorAccountCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* /* response ==
|
|
67
|
+
* {
|
|
68
|
+
* "Administrator": {
|
|
69
|
+
* "AccountId": "123456789012",
|
|
70
|
+
* "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb",
|
|
71
|
+
* "InvitedAt": "2020-06-01T20:21:18.042000+00:00",
|
|
72
|
+
* "MemberStatus": "ASSOCIATED"
|
|
73
|
+
* }
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-get-details-about-the-security-hub-administrator-account-1676998997182
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
60
79
|
*/
|
|
61
80
|
export declare class GetAdministratorAccountCommand extends $Command<GetAdministratorAccountCommandInput, GetAdministratorAccountCommandOutput, SecurityHubClientResolvedConfig> {
|
|
62
81
|
readonly input: GetAdministratorAccountCommandInput;
|
|
@@ -58,6 +58,31 @@ export interface GetEnabledStandardsCommandOutput extends GetEnabledStandardsRes
|
|
|
58
58
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
59
59
|
*
|
|
60
60
|
*
|
|
61
|
+
* @example To return a list of enabled standards
|
|
62
|
+
* ```javascript
|
|
63
|
+
* // The following example returns a list of Security Hub standards that are currently enabled in your account.
|
|
64
|
+
* const input = {
|
|
65
|
+
* "StandardsSubscriptionArns": [
|
|
66
|
+
* "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
|
|
67
|
+
* ]
|
|
68
|
+
* };
|
|
69
|
+
* const command = new GetEnabledStandardsCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* /* response ==
|
|
72
|
+
* {
|
|
73
|
+
* "StandardsSubscriptions": [
|
|
74
|
+
* {
|
|
75
|
+
* "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1",
|
|
76
|
+
* "StandardsInput": {},
|
|
77
|
+
* "StandardsStatus": "READY",
|
|
78
|
+
* "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
|
|
79
|
+
* }
|
|
80
|
+
* ]
|
|
81
|
+
* }
|
|
82
|
+
* *\/
|
|
83
|
+
* // example id: to-return-a-list-of-enabled-standards-1677090731129
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
61
86
|
*/
|
|
62
87
|
export declare class GetEnabledStandardsCommand extends $Command<GetEnabledStandardsCommandInput, GetEnabledStandardsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
63
88
|
readonly input: GetEnabledStandardsCommandInput;
|
|
@@ -60,6 +60,28 @@ export interface GetFindingAggregatorCommandOutput extends GetFindingAggregatorR
|
|
|
60
60
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
61
61
|
*
|
|
62
62
|
*
|
|
63
|
+
* @example To get cross-Region aggregation details
|
|
64
|
+
* ```javascript
|
|
65
|
+
* // The following example returns cross-Region aggregation details for the requesting account.
|
|
66
|
+
* const input = {
|
|
67
|
+
* "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
68
|
+
* };
|
|
69
|
+
* const command = new GetFindingAggregatorCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* /* response ==
|
|
72
|
+
* {
|
|
73
|
+
* "FindingAggregationRegion": "us-east-1",
|
|
74
|
+
* "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
75
|
+
* "RegionLinkingMode": "SPECIFIED_REGIONS",
|
|
76
|
+
* "Regions": [
|
|
77
|
+
* "us-west-1",
|
|
78
|
+
* "us-west-2"
|
|
79
|
+
* ]
|
|
80
|
+
* }
|
|
81
|
+
* *\/
|
|
82
|
+
* // example id: to-get-cross-region-aggregation-details-1677091474868
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
63
85
|
*/
|
|
64
86
|
export declare class GetFindingAggregatorCommand extends $Command<GetFindingAggregatorCommandInput, GetFindingAggregatorCommandOutput, SecurityHubClientResolvedConfig> {
|
|
65
87
|
readonly input: GetFindingAggregatorCommandInput;
|
|
@@ -313,6 +313,117 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat
|
|
|
313
313
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
314
314
|
*
|
|
315
315
|
*
|
|
316
|
+
* @example To get a list of findings
|
|
317
|
+
* ```javascript
|
|
318
|
+
* // The following example returns a filtered and sorted list of Security Hub findings.
|
|
319
|
+
* const input = {
|
|
320
|
+
* "Filters": {
|
|
321
|
+
* "AwsAccountId": [
|
|
322
|
+
* {
|
|
323
|
+
* "Comparison": "PREFIX",
|
|
324
|
+
* "Value": "123456789012"
|
|
325
|
+
* }
|
|
326
|
+
* ]
|
|
327
|
+
* },
|
|
328
|
+
* "MaxResults": 1
|
|
329
|
+
* };
|
|
330
|
+
* const command = new GetFindingsCommand(input);
|
|
331
|
+
* const response = await client.send(command);
|
|
332
|
+
* /* response ==
|
|
333
|
+
* {
|
|
334
|
+
* "Findings": [
|
|
335
|
+
* {
|
|
336
|
+
* "AwsAccountId": "123456789012",
|
|
337
|
+
* "CompanyName": "AWS",
|
|
338
|
+
* "Compliance": {
|
|
339
|
+
* "AssociatedStandards": [
|
|
340
|
+
* {
|
|
341
|
+
* "StandardsId": "standards/aws-foundational-security-best-practices/v/1.0.0"
|
|
342
|
+
* },
|
|
343
|
+
* {
|
|
344
|
+
* "StandardsId": "standards/pci-dss/v/3.2.1"
|
|
345
|
+
* },
|
|
346
|
+
* {
|
|
347
|
+
* "StandardsId": "ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
348
|
+
* },
|
|
349
|
+
* {
|
|
350
|
+
* "StandardsId": "standards/cis-aws-foundations-benchmark/v/1.4.0"
|
|
351
|
+
* },
|
|
352
|
+
* {
|
|
353
|
+
* "StandardsId": "standards/service-managed-aws-control-tower/v/1.0.0"
|
|
354
|
+
* }
|
|
355
|
+
* ],
|
|
356
|
+
* "RelatedRequirements": [
|
|
357
|
+
* "PCI DSS v3.2.1/3.4",
|
|
358
|
+
* "CIS AWS Foundations Benchmark v1.2.0/2.7",
|
|
359
|
+
* "CIS AWS Foundations Benchmark v1.4.0/3.7"
|
|
360
|
+
* ],
|
|
361
|
+
* "SecurityControlId": "CloudTrail.2",
|
|
362
|
+
* "Status": "FAILED"
|
|
363
|
+
* },
|
|
364
|
+
* "CreatedAt": "2022-10-06T02:18:23.076Z",
|
|
365
|
+
* "Description": "This AWS control checks whether AWS CloudTrail is configured to use the server side encryption (SSE) AWS Key Management Service (AWS KMS) customer master key (CMK) encryption. The check will pass if the KmsKeyId is defined.",
|
|
366
|
+
* "FindingProviderFields": {
|
|
367
|
+
* "Severity": {
|
|
368
|
+
* "Label": "MEDIUM",
|
|
369
|
+
* "Original": "MEDIUM"
|
|
370
|
+
* },
|
|
371
|
+
* "Types": [
|
|
372
|
+
* "Software and Configuration Checks/Industry and Regulatory Standards"
|
|
373
|
+
* ]
|
|
374
|
+
* },
|
|
375
|
+
* "FirstObservedAt": "2022-10-06T02:18:23.076Z",
|
|
376
|
+
* "GeneratorId": "security-control/CloudTrail.2",
|
|
377
|
+
* "Id": "arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
378
|
+
* "LastObservedAt": "2022-10-28T16:10:06.956Z",
|
|
379
|
+
* "ProductArn": "arn:aws:securityhub:us-east-2::product/aws/securityhub",
|
|
380
|
+
* "ProductFields": {
|
|
381
|
+
* "RelatedAWSResources:0/name": "securityhub-cloud-trail-encryption-enabled-fe95bf3f",
|
|
382
|
+
* "RelatedAWSResources:0/type": "AWS::Config::ConfigRule",
|
|
383
|
+
* "Resources:0/Id": "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
|
|
384
|
+
* "aws/securityhub/CompanyName": "AWS",
|
|
385
|
+
* "aws/securityhub/FindingId": "arn:aws:securityhub:us-east-2::product/aws/securityhub/arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
386
|
+
* "aws/securityhub/ProductName": "Security Hub"
|
|
387
|
+
* },
|
|
388
|
+
* "ProductName": "Security Hub",
|
|
389
|
+
* "RecordState": "ACTIVE",
|
|
390
|
+
* "Region": "us-east-2",
|
|
391
|
+
* "Remediation": {
|
|
392
|
+
* "Recommendation": {
|
|
393
|
+
* "Text": "For directions on how to correct this issue, consult the AWS Security Hub controls documentation.",
|
|
394
|
+
* "Url": "https://docs.aws.amazon.com/console/securityhub/CloudTrail.2/remediation"
|
|
395
|
+
* }
|
|
396
|
+
* },
|
|
397
|
+
* "Resources": [
|
|
398
|
+
* {
|
|
399
|
+
* "Id": "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
|
|
400
|
+
* "Partition": "aws",
|
|
401
|
+
* "Region": "us-east-2",
|
|
402
|
+
* "Type": "AwsCloudTrailTrail"
|
|
403
|
+
* }
|
|
404
|
+
* ],
|
|
405
|
+
* "SchemaVersion": "2018-10-08",
|
|
406
|
+
* "Severity": {
|
|
407
|
+
* "Label": "MEDIUM",
|
|
408
|
+
* "Normalized": 40,
|
|
409
|
+
* "Original": "MEDIUM"
|
|
410
|
+
* },
|
|
411
|
+
* "Title": "CloudTrail should have encryption at-rest enabled",
|
|
412
|
+
* "Types": [
|
|
413
|
+
* "Software and Configuration Checks/Industry and Regulatory Standards"
|
|
414
|
+
* ],
|
|
415
|
+
* "UpdatedAt": "2022-10-28T16:10:00.093Z",
|
|
416
|
+
* "Workflow": {
|
|
417
|
+
* "Status": "NEW"
|
|
418
|
+
* },
|
|
419
|
+
* "WorkflowState": "NEW"
|
|
420
|
+
* }
|
|
421
|
+
* ]
|
|
422
|
+
* }
|
|
423
|
+
* *\/
|
|
424
|
+
* // example id: to-get-a-list-of-findings-1677181069931
|
|
425
|
+
* ```
|
|
426
|
+
*
|
|
316
427
|
*/
|
|
317
428
|
export declare class GetFindingsCommand extends $Command<GetFindingsCommandInput, GetFindingsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
318
429
|
readonly input: GetFindingsCommandInput;
|
|
@@ -57,6 +57,35 @@ export interface GetInsightResultsCommandOutput extends GetInsightResultsRespons
|
|
|
57
57
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
58
58
|
*
|
|
59
59
|
*
|
|
60
|
+
* @example To get the results of a Security Hub insight
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // The following example returns the results of the Security Hub insight specified by the insight ARN.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
65
|
+
* };
|
|
66
|
+
* const command = new GetInsightResultsCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "InsightResults": {
|
|
71
|
+
* "GroupByAttribute": "ResourceId",
|
|
72
|
+
* "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
73
|
+
* "ResultValues": [
|
|
74
|
+
* {
|
|
75
|
+
* "Count": 10,
|
|
76
|
+
* "GroupByAttributeValue": "AWS::::Account:111122223333"
|
|
77
|
+
* },
|
|
78
|
+
* {
|
|
79
|
+
* "Count": 3,
|
|
80
|
+
* "GroupByAttributeValue": "AWS::::Account:444455556666"
|
|
81
|
+
* }
|
|
82
|
+
* ]
|
|
83
|
+
* }
|
|
84
|
+
* }
|
|
85
|
+
* *\/
|
|
86
|
+
* // example id: to-get-the-results-of-a-security-hub-insight-1677182822019
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
60
89
|
*/
|
|
61
90
|
export declare class GetInsightResultsCommand extends $Command<GetInsightResultsCommandInput, GetInsightResultsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
62
91
|
readonly input: GetInsightResultsCommandInput;
|
|
@@ -61,6 +61,44 @@ export interface GetInsightsCommandOutput extends GetInsightsResponse, __Metadat
|
|
|
61
61
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
62
62
|
*
|
|
63
63
|
*
|
|
64
|
+
* @example To get details of a Security Hub insight
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // The following example returns details of the Security Hub insight with the specified ARN.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "InsightArns": [
|
|
69
|
+
* "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
70
|
+
* ]
|
|
71
|
+
* };
|
|
72
|
+
* const command = new GetInsightsCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* /* response ==
|
|
75
|
+
* {
|
|
76
|
+
* "Insights": [
|
|
77
|
+
* {
|
|
78
|
+
* "Filters": {
|
|
79
|
+
* "ResourceType": [
|
|
80
|
+
* {
|
|
81
|
+
* "Comparison": "EQUALS",
|
|
82
|
+
* "Value": "AwsIamRole"
|
|
83
|
+
* }
|
|
84
|
+
* ],
|
|
85
|
+
* "SeverityLabel": [
|
|
86
|
+
* {
|
|
87
|
+
* "Comparison": "EQUALS",
|
|
88
|
+
* "Value": "CRITICAL"
|
|
89
|
+
* }
|
|
90
|
+
* ]
|
|
91
|
+
* },
|
|
92
|
+
* "GroupByAttribute": "ResourceId",
|
|
93
|
+
* "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
94
|
+
* "Name": "Critical role findings"
|
|
95
|
+
* }
|
|
96
|
+
* ]
|
|
97
|
+
* }
|
|
98
|
+
* *\/
|
|
99
|
+
* // example id: to-get-details-of-a-security-hub-insight-1677774127203
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
64
102
|
*/
|
|
65
103
|
export declare class GetInsightsCommand extends $Command<GetInsightsCommandInput, GetInsightsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
66
104
|
readonly input: GetInsightsCommandInput;
|
|
@@ -53,6 +53,22 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes
|
|
|
53
53
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
54
54
|
*
|
|
55
55
|
*
|
|
56
|
+
* @example To get a count of membership invitations
|
|
57
|
+
* ```javascript
|
|
58
|
+
* // The following example returns a count of invitations that the Security Hub administrator sent to the current member account, not including the currently accepted invitation.
|
|
59
|
+
* //
|
|
60
|
+
* //
|
|
61
|
+
* const input = undefined;
|
|
62
|
+
* const command = new GetInvitationsCountCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* /* response ==
|
|
65
|
+
* {
|
|
66
|
+
* "InvitationsCount": 3
|
|
67
|
+
* }
|
|
68
|
+
* *\/
|
|
69
|
+
* // example id: to-get-a-count-of-membership-invitations-1677774568793
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
56
72
|
*/
|
|
57
73
|
export declare class GetInvitationsCountCommand extends $Command<GetInvitationsCountCommandInput, GetInvitationsCountCommandOutput, SecurityHubClientResolvedConfig> {
|
|
58
74
|
readonly input: GetInvitationsCountCommandInput;
|
|
@@ -63,6 +63,43 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB
|
|
|
63
63
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
64
64
|
*
|
|
65
65
|
*
|
|
66
|
+
* @example To get member account details
|
|
67
|
+
* ```javascript
|
|
68
|
+
* // The following example returns details for the Security Hub member accounts with the specified AWS account IDs. An administrator account may be the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The Security Hub administrator must call this operation.
|
|
69
|
+
* const input = {
|
|
70
|
+
* "AccountIds": [
|
|
71
|
+
* "444455556666",
|
|
72
|
+
* "777788889999"
|
|
73
|
+
* ]
|
|
74
|
+
* };
|
|
75
|
+
* const command = new GetMembersCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* /* response ==
|
|
78
|
+
* {
|
|
79
|
+
* "Members": [
|
|
80
|
+
* {
|
|
81
|
+
* "AccountId": "444455556666",
|
|
82
|
+
* "AdministratorId": "123456789012",
|
|
83
|
+
* "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
|
|
84
|
+
* "MasterId": "123456789012",
|
|
85
|
+
* "MemberStatus": "ASSOCIATED",
|
|
86
|
+
* "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
|
|
87
|
+
* },
|
|
88
|
+
* {
|
|
89
|
+
* "AccountId": "777788889999",
|
|
90
|
+
* "AdministratorId": "123456789012",
|
|
91
|
+
* "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
|
|
92
|
+
* "MasterId": "123456789012",
|
|
93
|
+
* "MemberStatus": "ASSOCIATED",
|
|
94
|
+
* "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
|
|
95
|
+
* }
|
|
96
|
+
* ],
|
|
97
|
+
* "UnprocessedAccounts": []
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* // example id: to-get-member-account-details-1677774956489
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
66
103
|
*/
|
|
67
104
|
export declare class GetMembersCommand extends $Command<GetMembersCommandInput, GetMembersCommandOutput, SecurityHubClientResolvedConfig> {
|
|
68
105
|
readonly input: GetMembersCommandInput;
|
|
@@ -65,6 +65,25 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met
|
|
|
65
65
|
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
66
66
|
*
|
|
67
67
|
*
|
|
68
|
+
* @example To invite accounts to become members
|
|
69
|
+
* ```javascript
|
|
70
|
+
* // The following example invites the specified AWS accounts to become member accounts associated with the calling Security Hub administrator account. You only use this operation to invite accounts that don't belong to an AWS Organizations organization.
|
|
71
|
+
* const input = {
|
|
72
|
+
* "AccountIds": [
|
|
73
|
+
* "111122223333",
|
|
74
|
+
* "444455556666"
|
|
75
|
+
* ]
|
|
76
|
+
* };
|
|
77
|
+
* const command = new InviteMembersCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* /* response ==
|
|
80
|
+
* {
|
|
81
|
+
* "UnprocessedAccounts": []
|
|
82
|
+
* }
|
|
83
|
+
* *\/
|
|
84
|
+
* // example id: to-invite-accounts-to-become-members-1677775500860
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
68
87
|
*/
|
|
69
88
|
export declare class InviteMembersCommand extends $Command<InviteMembersCommandInput, InviteMembersCommandOutput, SecurityHubClientResolvedConfig> {
|
|
70
89
|
readonly input: InviteMembersCommandInput;
|
|
@@ -52,6 +52,23 @@ export interface ListEnabledProductsForImportCommandOutput extends ListEnabledPr
|
|
|
52
52
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
53
53
|
*
|
|
54
54
|
*
|
|
55
|
+
* @example To list ARNs for enabled integrations
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // The following example returns a list of subscription Amazon Resource Names (ARNs) for the product integrations that you have currently enabled in Security Hub.
|
|
58
|
+
* const input = undefined;
|
|
59
|
+
* const command = new ListEnabledProductsForImportCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* /* response ==
|
|
62
|
+
* {
|
|
63
|
+
* "ProductSubscriptions": [
|
|
64
|
+
* "arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon",
|
|
65
|
+
* "arn:aws:securityhub:us-east-1::product/3coresec/3coresec"
|
|
66
|
+
* ]
|
|
67
|
+
* }
|
|
68
|
+
* *\/
|
|
69
|
+
* // example id: to-list-arns-for-enabled-integrations-1678294870020
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
55
72
|
*/
|
|
56
73
|
export declare class ListEnabledProductsForImportCommand extends $Command<ListEnabledProductsForImportCommandInput, ListEnabledProductsForImportCommandOutput, SecurityHubClientResolvedConfig> {
|
|
57
74
|
readonly input: ListEnabledProductsForImportCommandInput;
|
|
@@ -58,6 +58,24 @@ export interface ListFindingAggregatorsCommandOutput extends ListFindingAggregat
|
|
|
58
58
|
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
59
59
|
*
|
|
60
60
|
*
|
|
61
|
+
* @example To update the enablement status of a standard control
|
|
62
|
+
* ```javascript
|
|
63
|
+
* // The following example disables the specified control in the specified security standard.
|
|
64
|
+
* const input = {};
|
|
65
|
+
* const command = new ListFindingAggregatorsCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* /* response ==
|
|
68
|
+
* {
|
|
69
|
+
* "FindingAggregators": [
|
|
70
|
+
* {
|
|
71
|
+
* "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
72
|
+
* }
|
|
73
|
+
* ]
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-update-the-enablement-status-of-a-standard-control-1678912506444
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
61
79
|
*/
|
|
62
80
|
export declare class ListFindingAggregatorsCommand extends $Command<ListFindingAggregatorsCommandInput, ListFindingAggregatorsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
63
81
|
readonly input: ListFindingAggregatorsCommandInput;
|