Skip to content

Commit 0364e48

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Documentation updates for AWS Security Hub
1 parent ef470ae commit 0364e48

File tree

75 files changed

+485
-2641
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+485
-2641
lines changed

‎generator/ServiceModels/securityhub/securityhub-2018-10-26.docs.json

Lines changed: 116 additions & 116 deletions
Large diffs are not rendered by default.

‎generator/ServiceModels/securityhub/securityhub-2018-10-26.normal.json

Lines changed: 116 additions & 116 deletions
Large diffs are not rendered by default.

‎sdk/src/Services/SecurityHub/Generated/Model/Actor.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ namespace Amazon.SecurityHub.Model
3333
/// Information about the threat actor identified in an Amazon GuardDuty Extended Threat
3434
/// Detection attack sequence. GuardDuty generates an attack sequence finding when multiple
3535
/// events align to a potentially suspicious activity. To receive GuardDuty attack sequence
36-
/// findings in Security Hub, you must have GuardDuty and GuardDuty S3 Protection enabled.
37-
/// For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
36+
/// findings in Security Hub, you must have GuardDuty enabled. For more information, see
37+
/// <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
3838
/// Extended Threat Detection </a> in the <i>Amazon GuardDuty User Guide</i>.
3939
/// </summary>
4040
public partial class Actor

‎sdk/src/Services/SecurityHub/Generated/Model/ActorSession.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace Amazon.SecurityHub.Model
3434
/// in an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates
3535
/// an attack sequence finding when multiple events align to a potentially suspicious
3636
/// activity. To receive GuardDuty attack sequence findings in Security Hub, you must
37-
/// have GuardDuty and GuardDuty S3 Protection enabled. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
37+
/// have GuardDuty enabled. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
3838
/// Extended Threat Detection </a> in the <i>Amazon GuardDuty User Guide</i>.
3939
/// </summary>
4040
public partial class ActorSession

‎sdk/src/Services/SecurityHub/Generated/Model/ActorUser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace Amazon.SecurityHub.Model
3434
/// an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates
3535
/// an attack sequence finding when multiple events align to a potentially suspicious
3636
/// activity. To receive GuardDuty attack sequence findings in Security Hub, you must
37-
/// have GuardDuty and GuardDuty S3 Protection enabled. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
37+
/// have GuardDuty enabled. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty
3838
/// Extended Threat Detection </a> in the <i>Amazon GuardDuty User Guide</i>.
3939
/// </summary>
4040
public partial class ActorUser

‎sdk/src/Services/SecurityHub/Generated/Model/AutomationRulesConfig.cs

Lines changed: 4 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -73,32 +73,9 @@ internal bool IsSetActions()
7373
/// </para>
7474
///
7575
/// <para>
76-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
77-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
78-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
79-
/// timestamp formats with examples:
76+
/// For more information about the validation and formatting of timestamp fields in Security
77+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
8078
/// </para>
81-
/// <ul> <li>
82-
/// <para>
83-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
84-
/// </para>
85-
/// </li> <li>
86-
/// <para>
87-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
88-
/// </para>
89-
/// </li> <li>
90-
/// <para>
91-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
92-
/// </para>
93-
/// </li> <li>
94-
/// <para>
95-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
96-
/// </para>
97-
/// </li> <li>
98-
/// <para>
99-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
100-
/// </para>
101-
/// </li> </ul>
10279
/// </summary>
10380
public DateTime CreatedAt
10481
{
@@ -276,32 +253,9 @@ internal bool IsSetRuleStatus()
276253
/// </para>
277254
///
278255
/// <para>
279-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
280-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
281-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
282-
/// timestamp formats with examples:
283-
/// </para>
284-
/// <ul> <li>
285-
/// <para>
286-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
287-
/// </para>
288-
/// </li> <li>
289-
/// <para>
290-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
291-
/// </para>
292-
/// </li> <li>
293-
/// <para>
294-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
295-
/// </para>
296-
/// </li> <li>
297-
/// <para>
298-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
299-
/// </para>
300-
/// </li> <li>
301-
/// <para>
302-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
256+
/// For more information about the validation and formatting of timestamp fields in Security
257+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
303258
/// </para>
304-
/// </li> </ul>
305259
/// </summary>
306260
public DateTime UpdatedAt
307261
{

‎sdk/src/Services/SecurityHub/Generated/Model/AutomationRulesFindingFilters.cs

Lines changed: 17 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -246,32 +246,10 @@ internal bool IsSetConfidence()
246246
/// </para>
247247
///
248248
/// <para>
249-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
250-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
251-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
252-
/// timestamp formats with examples:
249+
/// For more information about the validation and formatting of timestamp fields in Security
250+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
253251
/// </para>
254-
/// <ul> <li>
255-
/// <para>
256-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
257-
/// </para>
258-
/// </li> <li>
259-
/// <para>
260-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
261-
/// </para>
262-
/// </li> <li>
263-
/// <para>
264-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
265-
/// </para>
266-
/// </li> <li>
267-
/// <para>
268-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
269-
/// </para>
270-
/// </li> <li>
271-
/// <para>
272-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
273-
/// </para>
274-
/// </li> </ul>
252+
///
275253
/// <para>
276254
/// Array Members: Minimum number of 1 item. Maximum number of 20 items.
277255
/// </para>
@@ -345,32 +323,10 @@ internal bool IsSetDescription()
345323
/// </para>
346324
///
347325
/// <para>
348-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
349-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
350-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
351-
/// timestamp formats with examples:
352-
/// </para>
353-
/// <ul> <li>
354-
/// <para>
355-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
356-
/// </para>
357-
/// </li> <li>
358-
/// <para>
359-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
360-
/// </para>
361-
/// </li> <li>
362-
/// <para>
363-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
364-
/// </para>
365-
/// </li> <li>
366-
/// <para>
367-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
368-
/// </para>
369-
/// </li> <li>
370-
/// <para>
371-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
326+
/// For more information about the validation and formatting of timestamp fields in Security
327+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
372328
/// </para>
373-
/// </li> </ul>
329+
///
374330
/// <para>
375331
/// Array Members: Minimum number of 1 item. Maximum number of 20 items.
376332
/// </para>
@@ -434,37 +390,15 @@ internal bool IsSetId()
434390
/// <summary>
435391
/// Gets and sets the property LastObservedAt.
436392
/// <para>
437-
/// A timestamp that indicates when the potential security issue captured by a finding
438-
/// was most recently observed by the security findings product.
393+
/// A timestamp that indicates when the security findings provider most recently observed
394+
/// a change in the resource that is involved in the finding.
439395
/// </para>
440396
///
441397
/// <para>
442-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
443-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
444-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
445-
/// timestamp formats with examples:
446-
/// </para>
447-
/// <ul> <li>
448-
/// <para>
449-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
450-
/// </para>
451-
/// </li> <li>
452-
/// <para>
453-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
454-
/// </para>
455-
/// </li> <li>
456-
/// <para>
457-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
458-
/// </para>
459-
/// </li> <li>
460-
/// <para>
461-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
398+
/// For more information about the validation and formatting of timestamp fields in Security
399+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
462400
/// </para>
463-
/// </li> <li>
464-
/// <para>
465-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
466-
/// </para>
467-
/// </li> </ul>
401+
///
468402
/// <para>
469403
/// Array Members: Minimum number of 1 item. Maximum number of 20 items.
470404
/// </para>
@@ -510,32 +444,10 @@ internal bool IsSetNoteText()
510444
/// </para>
511445
///
512446
/// <para>
513-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
514-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
515-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
516-
/// timestamp formats with examples:
517-
/// </para>
518-
/// <ul> <li>
519-
/// <para>
520-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
521-
/// </para>
522-
/// </li> <li>
523-
/// <para>
524-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
525-
/// </para>
526-
/// </li> <li>
527-
/// <para>
528-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
529-
/// </para>
530-
/// </li> <li>
531-
/// <para>
532-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
447+
/// For more information about the validation and formatting of timestamp fields in Security
448+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
533449
/// </para>
534-
/// </li> <li>
535-
/// <para>
536-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
537-
/// </para>
538-
/// </li> </ul>
450+
///
539451
/// <para>
540452
/// Array Members: Minimum number of 1 item. Maximum number of 20 items.
541453
/// </para>
@@ -968,32 +880,10 @@ internal bool IsSetType()
968880
/// </para>
969881
///
970882
/// <para>
971-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
972-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
973-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
974-
/// timestamp formats with examples:
975-
/// </para>
976-
/// <ul> <li>
977-
/// <para>
978-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
979-
/// </para>
980-
/// </li> <li>
981-
/// <para>
982-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
883+
/// For more information about the validation and formatting of timestamp fields in Security
884+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
983885
/// </para>
984-
/// </li> <li>
985-
/// <para>
986-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
987-
/// </para>
988-
/// </li> <li>
989-
/// <para>
990-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
991-
/// </para>
992-
/// </li> <li>
993-
/// <para>
994-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
995-
/// </para>
996-
/// </li> </ul>
886+
///
997887
/// <para>
998888
/// Array Members: Minimum number of 1 item. Maximum number of 20 items.
999889
/// </para>

‎sdk/src/Services/SecurityHub/Generated/Model/AutomationRulesMetadata.cs

Lines changed: 4 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,9 @@ public partial class AutomationRulesMetadata
5252
/// </para>
5353
///
5454
/// <para>
55-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
56-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
57-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
58-
/// timestamp formats with examples:
55+
/// For more information about the validation and formatting of timestamp fields in Security
56+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
5957
/// </para>
60-
/// <ul> <li>
61-
/// <para>
62-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
63-
/// </para>
64-
/// </li> <li>
65-
/// <para>
66-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
67-
/// </para>
68-
/// </li> <li>
69-
/// <para>
70-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
71-
/// </para>
72-
/// </li> <li>
73-
/// <para>
74-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
75-
/// </para>
76-
/// </li> <li>
77-
/// <para>
78-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
79-
/// </para>
80-
/// </li> </ul>
8158
/// </summary>
8259
public DateTime CreatedAt
8360
{
@@ -234,32 +211,9 @@ internal bool IsSetRuleStatus()
234211
/// </para>
235212
///
236213
/// <para>
237-
/// This field accepts only the specified formats. Timestamps can end with <c>Z</c> or
238-
/// <c>("+" / "-") time-hour [":" time-minute]</c>. The time-secfrac after seconds is
239-
/// limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
240-
/// timestamp formats with examples:
241-
/// </para>
242-
/// <ul> <li>
243-
/// <para>
244-
/// <c>YYYY-MM-DDTHH:MM:SSZ</c> (for example, <c>2019-01-31T23:00:00Z</c>)
245-
/// </para>
246-
/// </li> <li>
247-
/// <para>
248-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ</c> (for example, <c>2019-01-31T23:00:00.123456789Z</c>)
249-
/// </para>
250-
/// </li> <li>
251-
/// <para>
252-
/// <c>YYYY-MM-DDTHH:MM:SS+HH:MM</c> (for example, <c>2024-01-04T15:25:10+17:59</c>)
253-
/// </para>
254-
/// </li> <li>
255-
/// <para>
256-
/// <c>YYYY-MM-DDTHH:MM:SS-HHMM</c> (for example, <c>2024-01-04T15:25:10-1759</c>)
257-
/// </para>
258-
/// </li> <li>
259-
/// <para>
260-
/// <c>YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM</c> (for example, <c>2024-01-04T15:25:10.123456789+17:59</c>)
214+
/// For more information about the validation and formatting of timestamp fields in Security
215+
/// Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.
261216
/// </para>
262-
/// </li> </ul>
263217
/// </summary>
264218
public DateTime UpdatedAt
265219
{

0 commit comments

Comments
 (0)