Skip to content

Commit 1f1a811

Browse files
author
awstools
committed
docs(client-securityhub): Documentation updates for AWS Security Hub
1 parent f8474ba commit 1f1a811

File tree

2 files changed

+142
-37
lines changed

2 files changed

+142
-37
lines changed

‎clients/client-securityhub/src/models/models_0.ts

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1477,12 +1477,18 @@ export interface AutomationRulesFindingFilters {
14771477
* The Amazon Resource Name (ARN) for a third-party product that generated a finding in
14781478
* Security Hub.
14791479
* </p>
1480+
* <p>
1481+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1482+
* </p>
14801483
*/
14811484
ProductArn?: StringFilter[];
14821485

14831486
/**
14841487
* @public
14851488
* <p> The Amazon Web Services account ID in which a finding was generated. </p>
1489+
* <p>
1490+
* Array Members: Minimum number of 1 item. Maximum number of 100 items.
1491+
* </p>
14861492
*/
14871493
AwsAccountId?: StringFilter[];
14881494

@@ -1491,6 +1497,9 @@ export interface AutomationRulesFindingFilters {
14911497
* <p>
14921498
* The product-specific identifier for a finding.
14931499
* </p>
1500+
* <p>
1501+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1502+
* </p>
14941503
*/
14951504
Id?: StringFilter[];
14961505

@@ -1500,14 +1509,20 @@ export interface AutomationRulesFindingFilters {
15001509
* The identifier for the solution-specific component that
15011510
* generated a finding.
15021511
* </p>
1512+
* <p>
1513+
* Array Members: Minimum number of 1 item. Maximum number of 100 items.
1514+
* </p>
15031515
*/
15041516
GeneratorId?: StringFilter[];
15051517

15061518
/**
15071519
* @public
15081520
* <p> One or more finding types in the format of namespace/category/classifier that classify
15091521
* a finding. For a list of namespaces, classifiers, and categories, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html">Types
1510-
* taxonomy for ASFF</a> in the <i>Security Hub User Guide</i>. </p>
1522+
* taxonomy for ASFF</a> in the <i>Security Hub User Guide</i>.</p>
1523+
* <p>
1524+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1525+
* </p>
15111526
*/
15121527
Type?: StringFilter[];
15131528

@@ -1520,6 +1535,9 @@ export interface AutomationRulesFindingFilters {
15201535
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
15211536
* Date/Time Format</a>. The value cannot contain spaces. For example,
15221537
* <code>2020-03-22T13:22:13.933Z</code>.</p>
1538+
* <p>
1539+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1540+
* </p>
15231541
*/
15241542
FirstObservedAt?: DateFilter[];
15251543

@@ -1532,6 +1550,9 @@ export interface AutomationRulesFindingFilters {
15321550
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
15331551
* Date/Time Format</a>. The value cannot contain spaces. For example,
15341552
* <code>2020-03-22T13:22:13.933Z</code>.</p>
1553+
* <p>
1554+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1555+
* </p>
15351556
*/
15361557
LastObservedAt?: DateFilter[];
15371558

@@ -1543,6 +1564,9 @@ export interface AutomationRulesFindingFilters {
15431564
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
15441565
* Date/Time Format</a>. The value cannot contain spaces. For example,
15451566
* <code>2020-03-22T13:22:13.933Z</code>.</p>
1567+
* <p>
1568+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1569+
* </p>
15461570
*/
15471571
CreatedAt?: DateFilter[];
15481572

@@ -1554,6 +1578,9 @@ export interface AutomationRulesFindingFilters {
15541578
* <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
15551579
* Date/Time Format</a>. The value cannot contain spaces. For example,
15561580
* <code>2020-03-22T13:22:13.933Z</code>.</p>
1581+
* <p>
1582+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1583+
* </p>
15571584
*/
15581585
UpdatedAt?: DateFilter[];
15591586

@@ -1564,7 +1591,10 @@ export interface AutomationRulesFindingFilters {
15641591
* scale. A value of <code>0</code> means 0 percent confidence, and a value of
15651592
* <code>100</code> means 100 percent confidence. For example, a data exfiltration
15661593
* detection based on a statistical deviation of network traffic has low confidence because an
1567-
* actual exfiltration hasn't been verified. For more information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence">Confidence</a> in the <i>Security Hub User Guide</i>. </p>
1594+
* actual exfiltration hasn't been verified. For more information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence">Confidence</a> in the <i>Security Hub User Guide</i>.</p>
1595+
* <p>
1596+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1597+
* </p>
15681598
*/
15691599
Confidence?: NumberFilter[];
15701600

@@ -1576,6 +1606,9 @@ export interface AutomationRulesFindingFilters {
15761606
* only full integers. A score of <code>0</code> means that the underlying resources have no
15771607
* criticality, and a score of <code>100</code> is reserved for the most critical resources. For
15781608
* more information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality">Criticality</a> in the <i>Security Hub User Guide</i>.</p>
1609+
* <p>
1610+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1611+
* </p>
15791612
*/
15801613
Criticality?: NumberFilter[];
15811614

@@ -1584,6 +1617,9 @@ export interface AutomationRulesFindingFilters {
15841617
* <p>
15851618
* A finding's title.
15861619
* </p>
1620+
* <p>
1621+
* Array Members: Minimum number of 1 item. Maximum number of 100 items.
1622+
* </p>
15871623
*/
15881624
Title?: StringFilter[];
15891625

@@ -1592,6 +1628,9 @@ export interface AutomationRulesFindingFilters {
15921628
* <p>
15931629
* A finding's description.
15941630
* </p>
1631+
* <p>
1632+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1633+
* </p>
15951634
*/
15961635
Description?: StringFilter[];
15971636

@@ -1600,6 +1639,9 @@ export interface AutomationRulesFindingFilters {
16001639
* <p>
16011640
* Provides a URL that links to a page about the current finding in the finding product.
16021641
* </p>
1642+
* <p>
1643+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1644+
* </p>
16031645
*/
16041646
SourceUrl?: StringFilter[];
16051647

@@ -1609,6 +1651,9 @@ export interface AutomationRulesFindingFilters {
16091651
* Provides the name of the product that generated the finding. For
16101652
* control-based findings, the product name is Security Hub.
16111653
* </p>
1654+
* <p>
1655+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1656+
* </p>
16121657
*/
16131658
ProductName?: StringFilter[];
16141659

@@ -1618,6 +1663,9 @@ export interface AutomationRulesFindingFilters {
16181663
* The name of the company for the product that generated the finding.
16191664
* For control-based findings, the company is Amazon Web Services.
16201665
* </p>
1666+
* <p>
1667+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1668+
* </p>
16211669
*/
16221670
CompanyName?: StringFilter[];
16231671

@@ -1626,6 +1674,9 @@ export interface AutomationRulesFindingFilters {
16261674
* <p>
16271675
* The severity value of the finding.
16281676
* </p>
1677+
* <p>
1678+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1679+
* </p>
16291680
*/
16301681
SeverityLabel?: StringFilter[];
16311682

@@ -1634,6 +1685,9 @@ export interface AutomationRulesFindingFilters {
16341685
* <p>
16351686
* The type of resource that the finding pertains to.
16361687
* </p>
1688+
* <p>
1689+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1690+
* </p>
16371691
*/
16381692
ResourceType?: StringFilter[];
16391693

@@ -1646,6 +1700,9 @@ export interface AutomationRulesFindingFilters {
16461700
* For non-Amazon Web Services resources, this is a unique identifier that is associated with the
16471701
* resource.
16481702
* </p>
1703+
* <p>
1704+
* Array Members: Minimum number of 1 item. Maximum number of 100 items.
1705+
* </p>
16491706
*/
16501707
ResourceId?: StringFilter[];
16511708

@@ -1655,6 +1712,9 @@ export interface AutomationRulesFindingFilters {
16551712
* The partition in which the resource that the finding pertains to is located.
16561713
* A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
16571714
* </p>
1715+
* <p>
1716+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1717+
* </p>
16581718
*/
16591719
ResourcePartition?: StringFilter[];
16601720

@@ -1663,6 +1723,9 @@ export interface AutomationRulesFindingFilters {
16631723
* <p>
16641724
* The Amazon Web Services Region where the resource that a finding pertains to is located.
16651725
* </p>
1726+
* <p>
1727+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1728+
* </p>
16661729
*/
16671730
ResourceRegion?: StringFilter[];
16681731

@@ -1671,6 +1734,9 @@ export interface AutomationRulesFindingFilters {
16711734
* <p>
16721735
* A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
16731736
* </p>
1737+
* <p>
1738+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1739+
* </p>
16741740
*/
16751741
ResourceTags?: MapFilter[];
16761742

@@ -1679,6 +1745,9 @@ export interface AutomationRulesFindingFilters {
16791745
* <p>
16801746
* Custom fields and values about the resource that a finding pertains to.
16811747
* </p>
1748+
* <p>
1749+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1750+
* </p>
16821751
*/
16831752
ResourceDetailsOther?: MapFilter[];
16841753

@@ -1688,19 +1757,28 @@ export interface AutomationRulesFindingFilters {
16881757
* The result of a security check. This field is only used for findings generated
16891758
* from controls.
16901759
* </p>
1760+
* <p>
1761+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1762+
* </p>
16911763
*/
16921764
ComplianceStatus?: StringFilter[];
16931765

16941766
/**
16951767
* @public
16961768
* <p> The security control ID for which a finding was generated. Security control IDs are the same across standards.</p>
1769+
* <p>
1770+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1771+
* </p>
16971772
*/
16981773
ComplianceSecurityControlId?: StringFilter[];
16991774

17001775
/**
17011776
* @public
17021777
* <p>The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of
17031778
* the Amazon Resource Name (ARN) returned for a standard in the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html">DescribeStandards</a> API response.</p>
1779+
* <p>
1780+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1781+
* </p>
17041782
*/
17051783
ComplianceAssociatedStandardsId?: StringFilter[];
17061784

@@ -1709,6 +1787,9 @@ export interface AutomationRulesFindingFilters {
17091787
* <p>
17101788
* Provides the veracity of a finding.
17111789
* </p>
1790+
* <p>
1791+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1792+
* </p>
17121793
*/
17131794
VerificationState?: StringFilter[];
17141795

@@ -1717,6 +1798,9 @@ export interface AutomationRulesFindingFilters {
17171798
* <p>
17181799
* Provides information about the status of the investigation into a finding.
17191800
* </p>
1801+
* <p>
1802+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1803+
* </p>
17201804
*/
17211805
WorkflowStatus?: StringFilter[];
17221806

@@ -1725,6 +1809,9 @@ export interface AutomationRulesFindingFilters {
17251809
* <p>
17261810
* Provides the current state of a finding.
17271811
* </p>
1812+
* <p>
1813+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1814+
* </p>
17281815
*/
17291816
RecordState?: StringFilter[];
17301817

@@ -1733,6 +1820,9 @@ export interface AutomationRulesFindingFilters {
17331820
* <p>
17341821
* The ARN for the product that generated a related finding.
17351822
* </p>
1823+
* <p>
1824+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1825+
* </p>
17361826
*/
17371827
RelatedFindingsProductArn?: StringFilter[];
17381828

@@ -1741,6 +1831,9 @@ export interface AutomationRulesFindingFilters {
17411831
* <p>
17421832
* The product-generated identifier for a related finding.
17431833
* </p>
1834+
* <p>
1835+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1836+
* </p>
17441837
*/
17451838
RelatedFindingsId?: StringFilter[];
17461839

@@ -1749,6 +1842,9 @@ export interface AutomationRulesFindingFilters {
17491842
* <p>
17501843
* The text of a user-defined note that's added to a finding.
17511844
* </p>
1845+
* <p>
1846+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1847+
* </p>
17521848
*/
17531849
NoteText?: StringFilter[];
17541850

@@ -1759,6 +1855,9 @@ export interface AutomationRulesFindingFilters {
17591855
* <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces.
17601856
* For example, <code>2020-03-22T13:22:13.933Z</code>.
17611857
* </p>
1858+
* <p>
1859+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1860+
* </p>
17621861
*/
17631862
NoteUpdatedAt?: DateFilter[];
17641863

@@ -1767,6 +1866,9 @@ export interface AutomationRulesFindingFilters {
17671866
* <p>
17681867
* The principal that created a note.
17691868
* </p>
1869+
* <p>
1870+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1871+
* </p>
17701872
*/
17711873
NoteUpdatedBy?: StringFilter[];
17721874

@@ -1775,6 +1877,9 @@ export interface AutomationRulesFindingFilters {
17751877
* <p>
17761878
* A list of user-defined name and value string pairs added to a finding.
17771879
* </p>
1880+
* <p>
1881+
* Array Members: Minimum number of 1 item. Maximum number of 20 items.
1882+
* </p>
17781883
*/
17791884
UserDefinedFields?: MapFilter[];
17801885
}

0 commit comments

Comments
 (0)