@aws-sdk/client-securityhub 3.774.0 → 3.777.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.
Files changed (86) hide show
  1. package/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
  2. package/dist-cjs/index.js +17 -18
  3. package/dist-es/SecurityHubClient.js +2 -1
  4. package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
  5. package/dist-es/endpoint/EndpointParameters.js +2 -3
  6. package/dist-es/runtimeExtensions.js +2 -14
  7. package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +8 -5
  8. package/dist-types/commands/AcceptInvitationCommand.d.ts +1 -0
  9. package/dist-types/commands/BatchDeleteAutomationRulesCommand.d.ts +9 -9
  10. package/dist-types/commands/BatchDisableStandardsCommand.d.ts +9 -9
  11. package/dist-types/commands/BatchEnableStandardsCommand.d.ts +10 -10
  12. package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts +49 -49
  13. package/dist-types/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +22 -22
  14. package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +33 -33
  15. package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +1 -50
  16. package/dist-types/commands/BatchImportFindingsCommand.d.ts +26 -26
  17. package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts +10 -10
  18. package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +30 -30
  19. package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +20 -20
  20. package/dist-types/commands/CreateActionTargetCommand.d.ts +7 -7
  21. package/dist-types/commands/CreateAutomationRuleCommand.d.ts +35 -35
  22. package/dist-types/commands/CreateConfigurationPolicyCommand.d.ts +37 -37
  23. package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +9 -9
  24. package/dist-types/commands/CreateInsightCommand.d.ts +13 -13
  25. package/dist-types/commands/CreateMembersCommand.d.ts +7 -7
  26. package/dist-types/commands/DeclineInvitationsCommand.d.ts +5 -5
  27. package/dist-types/commands/DeleteActionTargetCommand.d.ts +5 -5
  28. package/dist-types/commands/DeleteConfigurationPolicyCommand.d.ts +7 -4
  29. package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +7 -4
  30. package/dist-types/commands/DeleteInsightCommand.d.ts +5 -5
  31. package/dist-types/commands/DeleteInvitationsCommand.d.ts +5 -5
  32. package/dist-types/commands/DeleteMembersCommand.d.ts +5 -5
  33. package/dist-types/commands/DescribeActionTargetsCommand.d.ts +8 -8
  34. package/dist-types/commands/DescribeHubCommand.d.ts +8 -8
  35. package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +10 -10
  36. package/dist-types/commands/DescribeProductsCommand.d.ts +17 -17
  37. package/dist-types/commands/DescribeStandardsCommand.d.ts +21 -21
  38. package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +1 -46
  39. package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +7 -4
  40. package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +7 -4
  41. package/dist-types/commands/DisableSecurityHubCommand.d.ts +7 -4
  42. package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +7 -4
  43. package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +1 -0
  44. package/dist-types/commands/DisassociateMembersCommand.d.ts +7 -4
  45. package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +5 -5
  46. package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +7 -4
  47. package/dist-types/commands/EnableSecurityHubCommand.d.ts +9 -6
  48. package/dist-types/commands/GetAdministratorAccountCommand.d.ts +1 -19
  49. package/dist-types/commands/GetConfigurationPolicyAssociationCommand.d.ts +12 -12
  50. package/dist-types/commands/GetConfigurationPolicyCommand.d.ts +23 -23
  51. package/dist-types/commands/GetEnabledStandardsCommand.d.ts +9 -9
  52. package/dist-types/commands/GetFindingAggregatorCommand.d.ts +8 -8
  53. package/dist-types/commands/GetFindingHistoryCommand.d.ts +1 -42
  54. package/dist-types/commands/GetFindingsCommand.d.ts +63 -63
  55. package/dist-types/commands/GetInsightResultsCommand.d.ts +12 -12
  56. package/dist-types/commands/GetInsightsCommand.d.ts +15 -15
  57. package/dist-types/commands/GetInvitationsCountCommand.d.ts +7 -7
  58. package/dist-types/commands/GetMasterAccountCommand.d.ts +1 -0
  59. package/dist-types/commands/GetMembersCommand.d.ts +1 -37
  60. package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +19 -19
  61. package/dist-types/commands/InviteMembersCommand.d.ts +5 -5
  62. package/dist-types/commands/ListAutomationRulesCommand.d.ts +23 -23
  63. package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +13 -13
  64. package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +15 -15
  65. package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +5 -5
  66. package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +6 -6
  67. package/dist-types/commands/ListInvitationsCommand.d.ts +1 -21
  68. package/dist-types/commands/ListMembersCommand.d.ts +1 -31
  69. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +7 -7
  70. package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +28 -28
  71. package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +1 -44
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
  73. package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +13 -13
  74. package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +9 -6
  75. package/dist-types/commands/TagResourceCommand.d.ts +10 -7
  76. package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
  77. package/dist-types/commands/UpdateActionTargetCommand.d.ts +9 -6
  78. package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +39 -39
  79. package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +10 -10
  80. package/dist-types/commands/UpdateFindingsCommand.d.ts +1 -0
  81. package/dist-types/commands/UpdateInsightCommand.d.ts +15 -12
  82. package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +10 -7
  83. package/dist-types/commands/UpdateSecurityControlCommand.d.ts +13 -10
  84. package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +8 -5
  85. package/dist-types/commands/UpdateStandardsControlCommand.d.ts +9 -6
  86. package/package.json +33 -33
@@ -83,29 +83,29 @@ declare const GetFindingAggregatorCommand_base: {
83
83
  * @throws {@link SecurityHubServiceException}
84
84
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
85
85
  *
86
- * @public
86
+ *
87
87
  * @example To get cross-Region aggregation details
88
88
  * ```javascript
89
89
  * // The following example returns cross-Region aggregation details for the requesting account.
90
90
  * const input = {
91
- * "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
91
+ * FindingAggregatorArn: "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
92
92
  * };
93
93
  * const command = new GetFindingAggregatorCommand(input);
94
94
  * const response = await client.send(command);
95
- * /* response ==
95
+ * /* response is
96
96
  * {
97
- * "FindingAggregationRegion": "us-east-1",
98
- * "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
99
- * "RegionLinkingMode": "SPECIFIED_REGIONS",
100
- * "Regions": [
97
+ * FindingAggregationRegion: "us-east-1",
98
+ * FindingAggregatorArn: "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
99
+ * RegionLinkingMode: "SPECIFIED_REGIONS",
100
+ * Regions: [
101
101
  * "us-west-1",
102
102
  * "us-west-2"
103
103
  * ]
104
104
  * }
105
105
  * *\/
106
- * // example id: to-get-cross-region-aggregation-details-1677091474868
107
106
  * ```
108
107
  *
108
+ * @public
109
109
  */
110
110
  export declare class GetFindingAggregatorCommand extends GetFindingAggregatorCommand_base {
111
111
  /** @internal type navigation helper, not in runtime. */
@@ -100,49 +100,8 @@ declare const GetFindingHistoryCommand_base: {
100
100
  * @throws {@link SecurityHubServiceException}
101
101
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
102
102
  *
103
- * @public
104
- * @example To get finding history
105
- * ```javascript
106
- * // The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.
107
- * const input = {
108
- * "EndTime": "2021-09-31T15:53:35.573Z",
109
- * "FindingIdentifier": {
110
- * "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
111
- * "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
112
- * },
113
- * "MaxResults": 2,
114
- * "StartTime": "2021-09-30T15:53:35.573Z"
115
- * };
116
- * const command = new GetFindingHistoryCommand(input);
117
- * const response = await client.send(command);
118
- * /* response ==
119
- * {
120
- * "Records": [
121
- * {
122
- * "FindingCreated": false,
123
- * "FindingIdentifier": {
124
- * "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
125
- * "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
126
- * },
127
- * "UpdateSource": {
128
- * "Identity": "arn:aws:iam::444455556666:role/Admin",
129
- * "Type": "BATCH_UPDATE_FINDINGS"
130
- * },
131
- * "UpdateTime": "2021-09-31T15:52:25.573Z",
132
- * "Updates": [
133
- * {
134
- * "NewValue": "MEDIUM",
135
- * "OldValue": "HIGH",
136
- * "UpdatedField": "Severity"
137
- * }
138
- * ]
139
- * }
140
- * ]
141
- * }
142
- * *\/
143
- * // example id: to-get-finding-history-1680270012186
144
- * ```
145
103
  *
104
+ * @public
146
105
  */
147
106
  export declare class GetFindingHistoryCommand extends GetFindingHistoryCommand_base {
148
107
  /** @internal type navigation helper, not in runtime. */
@@ -4608,118 +4608,118 @@ declare const GetFindingsCommand_base: {
4608
4608
  * @throws {@link SecurityHubServiceException}
4609
4609
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
4610
4610
  *
4611
- * @public
4611
+ *
4612
4612
  * @example To get a list of findings
4613
4613
  * ```javascript
4614
4614
  * // The following example returns a filtered and sorted list of Security Hub findings.
4615
4615
  * const input = {
4616
- * "Filters": {
4617
- * "AwsAccountId": [
4616
+ * Filters: {
4617
+ * AwsAccountId: [
4618
4618
  * {
4619
- * "Comparison": "PREFIX",
4620
- * "Value": "123456789012"
4619
+ * Comparison: "PREFIX",
4620
+ * Value: "123456789012"
4621
4621
  * }
4622
4622
  * ]
4623
4623
  * },
4624
- * "MaxResults": 1
4624
+ * MaxResults: 1
4625
4625
  * };
4626
4626
  * const command = new GetFindingsCommand(input);
4627
4627
  * const response = await client.send(command);
4628
- * /* response ==
4628
+ * /* response is
4629
4629
  * {
4630
- * "Findings": [
4630
+ * Findings: [
4631
4631
  * {
4632
- * "AwsAccountId": "123456789012",
4633
- * "CompanyName": "AWS",
4634
- * "Compliance": {
4635
- * "AssociatedStandards": [
4632
+ * AwsAccountId: "123456789012",
4633
+ * CompanyName: "AWS",
4634
+ * Compliance: {
4635
+ * AssociatedStandards: [
4636
4636
  * {
4637
- * "StandardsId": "standards/aws-foundational-security-best-practices/v/1.0.0"
4637
+ * StandardsId: "standards/aws-foundational-security-best-practices/v/1.0.0"
4638
4638
  * },
4639
4639
  * {
4640
- * "StandardsId": "standards/pci-dss/v/3.2.1"
4640
+ * StandardsId: "standards/pci-dss/v/3.2.1"
4641
4641
  * },
4642
4642
  * {
4643
- * "StandardsId": "ruleset/cis-aws-foundations-benchmark/v/1.2.0"
4643
+ * StandardsId: "ruleset/cis-aws-foundations-benchmark/v/1.2.0"
4644
4644
  * },
4645
4645
  * {
4646
- * "StandardsId": "standards/cis-aws-foundations-benchmark/v/1.4.0"
4646
+ * StandardsId: "standards/cis-aws-foundations-benchmark/v/1.4.0"
4647
4647
  * },
4648
4648
  * {
4649
- * "StandardsId": "standards/service-managed-aws-control-tower/v/1.0.0"
4649
+ * StandardsId: "standards/service-managed-aws-control-tower/v/1.0.0"
4650
4650
  * }
4651
4651
  * ],
4652
- * "RelatedRequirements": [
4652
+ * RelatedRequirements: [
4653
4653
  * "PCI DSS v3.2.1/3.4",
4654
4654
  * "CIS AWS Foundations Benchmark v1.2.0/2.7",
4655
4655
  * "CIS AWS Foundations Benchmark v1.4.0/3.7"
4656
4656
  * ],
4657
- * "SecurityControlId": "CloudTrail.2",
4658
- * "Status": "FAILED"
4657
+ * SecurityControlId: "CloudTrail.2",
4658
+ * Status: "FAILED"
4659
4659
  * },
4660
- * "CreatedAt": "2022-10-06T02:18:23.076Z",
4661
- * "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.",
4662
- * "FindingProviderFields": {
4663
- * "Severity": {
4664
- * "Label": "MEDIUM",
4665
- * "Original": "MEDIUM"
4660
+ * CreatedAt: "2022-10-06T02:18:23.076Z",
4661
+ * 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.",
4662
+ * FindingProviderFields: {
4663
+ * Severity: {
4664
+ * Label: "MEDIUM",
4665
+ * Original: "MEDIUM"
4666
4666
  * },
4667
- * "Types": [
4667
+ * Types: [
4668
4668
  * "Software and Configuration Checks/Industry and Regulatory Standards"
4669
4669
  * ]
4670
4670
  * },
4671
- * "FirstObservedAt": "2022-10-06T02:18:23.076Z",
4672
- * "GeneratorId": "security-control/CloudTrail.2",
4673
- * "Id": "arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
4674
- * "LastObservedAt": "2022-10-28T16:10:06.956Z",
4675
- * "ProductArn": "arn:aws:securityhub:us-east-2::product/aws/securityhub",
4676
- * "ProductFields": {
4677
- * "RelatedAWSResources:0/name": "securityhub-cloud-trail-encryption-enabled-fe95bf3f",
4678
- * "RelatedAWSResources:0/type": "AWS::Config::ConfigRule",
4679
- * "Resources:0/Id": "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
4680
- * "aws/securityhub/CompanyName": "AWS",
4681
- * "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",
4682
- * "aws/securityhub/ProductName": "Security Hub"
4671
+ * FirstObservedAt: "2022-10-06T02:18:23.076Z",
4672
+ * GeneratorId: "security-control/CloudTrail.2",
4673
+ * Id: "arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
4674
+ * LastObservedAt: "2022-10-28T16:10:06.956Z",
4675
+ * ProductArn: "arn:aws:securityhub:us-east-2::product/aws/securityhub",
4676
+ * ProductFields: {
4677
+ * RelatedAWSResources:0/name: "securityhub-cloud-trail-encryption-enabled-fe95bf3f",
4678
+ * RelatedAWSResources:0/type: "AWS::Config::ConfigRule",
4679
+ * Resources:0/Id: "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
4680
+ * aws/securityhub/CompanyName: "AWS",
4681
+ * 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",
4682
+ * aws/securityhub/ProductName: "Security Hub"
4683
4683
  * },
4684
- * "ProductName": "Security Hub",
4685
- * "RecordState": "ACTIVE",
4686
- * "Region": "us-east-2",
4687
- * "Remediation": {
4688
- * "Recommendation": {
4689
- * "Text": "For directions on how to correct this issue, consult the AWS Security Hub controls documentation.",
4690
- * "Url": "https://docs.aws.amazon.com/console/securityhub/CloudTrail.2/remediation"
4684
+ * ProductName: "Security Hub",
4685
+ * RecordState: "ACTIVE",
4686
+ * Region: "us-east-2",
4687
+ * Remediation: {
4688
+ * Recommendation: {
4689
+ * Text: "For directions on how to correct this issue, consult the AWS Security Hub controls documentation.",
4690
+ * Url: "https://docs.aws.amazon.com/console/securityhub/CloudTrail.2/remediation"
4691
4691
  * }
4692
4692
  * },
4693
- * "Resources": [
4693
+ * Resources: [
4694
4694
  * {
4695
- * "Id": "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
4696
- * "Partition": "aws",
4697
- * "Region": "us-east-2",
4698
- * "Type": "AwsCloudTrailTrail"
4695
+ * Id: "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
4696
+ * Partition: "aws",
4697
+ * Region: "us-east-2",
4698
+ * Type: "AwsCloudTrailTrail"
4699
4699
  * }
4700
4700
  * ],
4701
- * "SchemaVersion": "2018-10-08",
4702
- * "Severity": {
4703
- * "Label": "MEDIUM",
4704
- * "Normalized": 40,
4705
- * "Original": "MEDIUM"
4701
+ * SchemaVersion: "2018-10-08",
4702
+ * Severity: {
4703
+ * Label: "MEDIUM",
4704
+ * Normalized: 40,
4705
+ * Original: "MEDIUM"
4706
4706
  * },
4707
- * "Title": "CloudTrail should have encryption at-rest enabled",
4708
- * "Types": [
4707
+ * Title: "CloudTrail should have encryption at-rest enabled",
4708
+ * Types: [
4709
4709
  * "Software and Configuration Checks/Industry and Regulatory Standards"
4710
4710
  * ],
4711
- * "UpdatedAt": "2022-10-28T16:10:00.093Z",
4712
- * "Workflow": {
4713
- * "Status": "NEW"
4711
+ * UpdatedAt: "2022-10-28T16:10:00.093Z",
4712
+ * Workflow: {
4713
+ * Status: "NEW"
4714
4714
  * },
4715
- * "WorkflowState": "NEW"
4715
+ * WorkflowState: "NEW"
4716
4716
  * }
4717
4717
  * ]
4718
4718
  * }
4719
4719
  * *\/
4720
- * // example id: to-get-a-list-of-findings-1677181069931
4721
4720
  * ```
4722
4721
  *
4722
+ * @public
4723
4723
  */
4724
4724
  export declare class GetFindingsCommand extends GetFindingsCommand_base {
4725
4725
  /** @internal type navigation helper, not in runtime. */
@@ -80,36 +80,36 @@ declare const GetInsightResultsCommand_base: {
80
80
  * @throws {@link SecurityHubServiceException}
81
81
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
82
82
  *
83
- * @public
83
+ *
84
84
  * @example To get the results of a Security Hub insight
85
85
  * ```javascript
86
86
  * // The following example returns the results of the Security Hub insight specified by the insight ARN.
87
87
  * const input = {
88
- * "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
88
+ * InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
89
89
  * };
90
90
  * const command = new GetInsightResultsCommand(input);
91
91
  * const response = await client.send(command);
92
- * /* response ==
92
+ * /* response is
93
93
  * {
94
- * "InsightResults": {
95
- * "GroupByAttribute": "ResourceId",
96
- * "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
97
- * "ResultValues": [
94
+ * InsightResults: {
95
+ * GroupByAttribute: "ResourceId",
96
+ * InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
97
+ * ResultValues: [
98
98
  * {
99
- * "Count": 10,
100
- * "GroupByAttributeValue": "AWS::::Account:111122223333"
99
+ * Count: 10,
100
+ * GroupByAttributeValue: "AWS::::Account:111122223333"
101
101
  * },
102
102
  * {
103
- * "Count": 3,
104
- * "GroupByAttributeValue": "AWS::::Account:444455556666"
103
+ * Count: 3,
104
+ * GroupByAttributeValue: "AWS::::Account:444455556666"
105
105
  * }
106
106
  * ]
107
107
  * }
108
108
  * }
109
109
  * *\/
110
- * // example id: to-get-the-results-of-a-security-hub-insight-1677182822019
111
110
  * ```
112
111
  *
112
+ * @public
113
113
  */
114
114
  export declare class GetInsightResultsCommand extends GetInsightResultsCommand_base {
115
115
  /** @internal type navigation helper, not in runtime. */
@@ -350,45 +350,45 @@ declare const GetInsightsCommand_base: {
350
350
  * @throws {@link SecurityHubServiceException}
351
351
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
352
352
  *
353
- * @public
353
+ *
354
354
  * @example To get details of a Security Hub insight
355
355
  * ```javascript
356
356
  * // The following example returns details of the Security Hub insight with the specified ARN.
357
357
  * const input = {
358
- * "InsightArns": [
358
+ * InsightArns: [
359
359
  * "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
360
360
  * ]
361
361
  * };
362
362
  * const command = new GetInsightsCommand(input);
363
363
  * const response = await client.send(command);
364
- * /* response ==
364
+ * /* response is
365
365
  * {
366
- * "Insights": [
366
+ * Insights: [
367
367
  * {
368
- * "Filters": {
369
- * "ResourceType": [
368
+ * Filters: {
369
+ * ResourceType: [
370
370
  * {
371
- * "Comparison": "EQUALS",
372
- * "Value": "AwsIamRole"
371
+ * Comparison: "EQUALS",
372
+ * Value: "AwsIamRole"
373
373
  * }
374
374
  * ],
375
- * "SeverityLabel": [
375
+ * SeverityLabel: [
376
376
  * {
377
- * "Comparison": "EQUALS",
378
- * "Value": "CRITICAL"
377
+ * Comparison: "EQUALS",
378
+ * Value: "CRITICAL"
379
379
  * }
380
380
  * ]
381
381
  * },
382
- * "GroupByAttribute": "ResourceId",
383
- * "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
384
- * "Name": "Critical role findings"
382
+ * GroupByAttribute: "ResourceId",
383
+ * InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
384
+ * Name: "Critical role findings"
385
385
  * }
386
386
  * ]
387
387
  * }
388
388
  * *\/
389
- * // example id: to-get-details-of-a-security-hub-insight-1677774127203
390
389
  * ```
391
390
  *
391
+ * @public
392
392
  */
393
393
  export declare class GetInsightsCommand extends GetInsightsCommand_base {
394
394
  /** @internal type navigation helper, not in runtime. */
@@ -72,23 +72,23 @@ declare const GetInvitationsCountCommand_base: {
72
72
  * @throws {@link SecurityHubServiceException}
73
73
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
74
74
  *
75
- * @public
75
+ *
76
76
  * @example To get a count of membership invitations
77
77
  * ```javascript
78
78
  * // 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.
79
- * //
80
- * //
81
- * const input = {};
79
+ *
80
+ *
81
+ * const input = { /* empty *\/ };
82
82
  * const command = new GetInvitationsCountCommand(input);
83
83
  * const response = await client.send(command);
84
- * /* response ==
84
+ * /* response is
85
85
  * {
86
- * "InvitationsCount": 3
86
+ * InvitationsCount: 3
87
87
  * }
88
88
  * *\/
89
- * // example id: to-get-a-count-of-membership-invitations-1677774568793
90
89
  * ```
91
90
  *
91
+ * @public
92
92
  */
93
93
  export declare class GetInvitationsCountCommand extends GetInvitationsCountCommand_base {
94
94
  /** @internal type navigation helper, not in runtime. */
@@ -80,6 +80,7 @@ declare const GetMasterAccountCommand_base: {
80
80
  * @throws {@link SecurityHubServiceException}
81
81
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
82
82
  *
83
+ *
83
84
  * @public
84
85
  */
85
86
  export declare class GetMasterAccountCommand extends GetMasterAccountCommand_base {
@@ -93,44 +93,8 @@ declare const GetMembersCommand_base: {
93
93
  * @throws {@link SecurityHubServiceException}
94
94
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
95
95
  *
96
- * @public
97
- * @example To get member account details
98
- * ```javascript
99
- * // 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.
100
- * const input = {
101
- * "AccountIds": [
102
- * "444455556666",
103
- * "777788889999"
104
- * ]
105
- * };
106
- * const command = new GetMembersCommand(input);
107
- * const response = await client.send(command);
108
- * /* response ==
109
- * {
110
- * "Members": [
111
- * {
112
- * "AccountId": "444455556666",
113
- * "AdministratorId": "123456789012",
114
- * "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
115
- * "MasterId": "123456789012",
116
- * "MemberStatus": "ASSOCIATED",
117
- * "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
118
- * },
119
- * {
120
- * "AccountId": "777788889999",
121
- * "AdministratorId": "123456789012",
122
- * "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
123
- * "MasterId": "123456789012",
124
- * "MemberStatus": "ASSOCIATED",
125
- * "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
126
- * }
127
- * ],
128
- * "UnprocessedAccounts": []
129
- * }
130
- * *\/
131
- * // example id: to-get-member-account-details-1677774956489
132
- * ```
133
96
  *
97
+ * @public
134
98
  */
135
99
  export declare class GetMembersCommand extends GetMembersCommand_base {
136
100
  /** @internal type navigation helper, not in runtime. */
@@ -139,42 +139,42 @@ declare const GetSecurityControlDefinitionCommand_base: {
139
139
  * @throws {@link SecurityHubServiceException}
140
140
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
141
141
  *
142
- * @public
142
+ *
143
143
  * @example To get the definition of a security control.
144
144
  * ```javascript
145
145
  * // The following example retrieves definition details for the specified security control.
146
146
  * const input = {
147
- * "SecurityControlId": "EC2.4"
147
+ * SecurityControlId: "EC2.4"
148
148
  * };
149
149
  * const command = new GetSecurityControlDefinitionCommand(input);
150
150
  * const response = await client.send(command);
151
- * /* response ==
151
+ * /* response is
152
152
  * {
153
- * "SecurityControlDefinition": {
154
- * "CurrentRegionAvailability": "AVAILABLE",
155
- * "Description": "This control checks whether an Amazon EC2 instance has been stopped for longer than the allowed number of days. The control fails if an EC2 instance is stopped for longer than the maximum allowed time period. Unless you provide a custom parameter value for the maximum allowed time period, Security Hub uses a default value of 30 days.",
156
- * "ParameterDefinitions": {
157
- * "AllowedDays": {
158
- * "ConfigurationOptions": {
159
- * "Integer": {
160
- * "DefaultValue": 30,
161
- * "Max": 365,
162
- * "Min": 1
153
+ * SecurityControlDefinition: {
154
+ * CurrentRegionAvailability: "AVAILABLE",
155
+ * Description: "This control checks whether an Amazon EC2 instance has been stopped for longer than the allowed number of days. The control fails if an EC2 instance is stopped for longer than the maximum allowed time period. Unless you provide a custom parameter value for the maximum allowed time period, Security Hub uses a default value of 30 days.",
156
+ * ParameterDefinitions: {
157
+ * AllowedDays: {
158
+ * ConfigurationOptions: {
159
+ * Integer: {
160
+ * DefaultValue: 30,
161
+ * Max: 365,
162
+ * Min: 1
163
163
  * }
164
164
  * },
165
- * "Description": "Number of days the EC2 instance is allowed to be in a stopped state before generating a failed finding"
165
+ * Description: "Number of days the EC2 instance is allowed to be in a stopped state before generating a failed finding"
166
166
  * }
167
167
  * },
168
- * "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/EC2.4/remediation",
169
- * "SecurityControlId": "EC2.4",
170
- * "SeverityRating": "MEDIUM",
171
- * "Title": "Stopped Amazon EC2 instances should be removed after a specified time period"
168
+ * RemediationUrl: "https://docs.aws.amazon.com/console/securityhub/EC2.4/remediation",
169
+ * SecurityControlId: "EC2.4",
170
+ * SeverityRating: "MEDIUM",
171
+ * Title: "Stopped Amazon EC2 instances should be removed after a specified time period"
172
172
  * }
173
173
  * }
174
174
  * *\/
175
- * // example id: to-get-the-definition-of-a-security-control-1699283789356
176
175
  * ```
177
176
  *
177
+ * @public
178
178
  */
179
179
  export declare class GetSecurityControlDefinitionCommand extends GetSecurityControlDefinitionCommand_base {
180
180
  /** @internal type navigation helper, not in runtime. */
@@ -89,26 +89,26 @@ declare const InviteMembersCommand_base: {
89
89
  * @throws {@link SecurityHubServiceException}
90
90
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
91
91
  *
92
- * @public
92
+ *
93
93
  * @example To invite accounts to become members
94
94
  * ```javascript
95
95
  * // 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.
96
96
  * const input = {
97
- * "AccountIds": [
97
+ * AccountIds: [
98
98
  * "111122223333",
99
99
  * "444455556666"
100
100
  * ]
101
101
  * };
102
102
  * const command = new InviteMembersCommand(input);
103
103
  * const response = await client.send(command);
104
- * /* response ==
104
+ * /* response is
105
105
  * {
106
- * "UnprocessedAccounts": []
106
+ * UnprocessedAccounts: []
107
107
  * }
108
108
  * *\/
109
- * // example id: to-invite-accounts-to-become-members-1677775500860
110
109
  * ```
111
110
  *
111
+ * @public
112
112
  */
113
113
  export declare class InviteMembersCommand extends InviteMembersCommand_base {
114
114
  /** @internal type navigation helper, not in runtime. */
@@ -87,46 +87,46 @@ declare const ListAutomationRulesCommand_base: {
87
87
  * @throws {@link SecurityHubServiceException}
88
88
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
89
89
  *
90
- * @public
90
+ *
91
91
  * @example To list automation rules
92
92
  * ```javascript
93
93
  * // The following example lists automation rules and rule metadata in the calling account.
94
94
  * const input = {
95
- * "MaxResults": 2,
96
- * "NextToken": "example-token"
95
+ * MaxResults: 2,
96
+ * NextToken: "example-token"
97
97
  * };
98
98
  * const command = new ListAutomationRulesCommand(input);
99
99
  * const response = await client.send(command);
100
- * /* response ==
100
+ * /* response is
101
101
  * {
102
- * "AutomationRulesMetadata": [
102
+ * AutomationRulesMetadata: [
103
103
  * {
104
- * "CreatedAt": "2022-08-31T01:52:33.250Z",
105
- * "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
106
- * "Description": "IAM.8 is a known issue and can be resolved",
107
- * "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
108
- * "RuleName": "sample-rule-name-1",
109
- * "RuleOrder": 1,
110
- * "RuleStatus": "ENABLED",
111
- * "UpdatedAt": "2022-08-31T01:52:33.250Z"
104
+ * CreatedAt: "2022-08-31T01:52:33.250Z",
105
+ * CreatedBy: "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
106
+ * Description: "IAM.8 is a known issue and can be resolved",
107
+ * RuleArn: "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
108
+ * RuleName: "sample-rule-name-1",
109
+ * RuleOrder: 1,
110
+ * RuleStatus: "ENABLED",
111
+ * UpdatedAt: "2022-08-31T01:52:33.250Z"
112
112
  * },
113
113
  * {
114
- * "CreatedAt": "2022-08-31T01:52:33.250Z",
115
- * "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
116
- * "Description": "Lambda.2 is a known issue and can be resolved",
117
- * "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
118
- * "RuleName": "sample-rule-name-2",
119
- * "RuleOrder": 2,
120
- * "RuleStatus": "ENABLED",
121
- * "UpdatedAt": "2022-08-31T01:52:33.250Z"
114
+ * CreatedAt: "2022-08-31T01:52:33.250Z",
115
+ * CreatedBy: "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
116
+ * Description: "Lambda.2 is a known issue and can be resolved",
117
+ * RuleArn: "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
118
+ * RuleName: "sample-rule-name-2",
119
+ * RuleOrder: 2,
120
+ * RuleStatus: "ENABLED",
121
+ * UpdatedAt: "2022-08-31T01:52:33.250Z"
122
122
  * }
123
123
  * ],
124
- * "NextToken": "example-token"
124
+ * NextToken: "example-token"
125
125
  * }
126
126
  * *\/
127
- * // example id: to-list-automation-rules-1684770582059
128
127
  * ```
129
128
  *
129
+ * @public
130
130
  */
131
131
  export declare class ListAutomationRulesCommand extends ListAutomationRulesCommand_base {
132
132
  /** @internal type navigation helper, not in runtime. */