Skip to content

Commit 5beb1c7

Browse files
author
awstools
committed
docs(client-guardduty): Improved descriptions for certain APIs.
1 parent c149c7a commit 5beb1c7

File tree

3 files changed

+27
-19
lines changed

3 files changed

+27
-19
lines changed

clients/client-guardduty/src/models/models_0.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2714,12 +2714,17 @@ export interface CreateFilterRequest {
27142714
* </li>
27152715
* <li>
27162716
* <p>
2717-
* <b>High</b>: <code>["7", "8", "9"]</code>
2717+
* <b>High</b>: <code>["7", "8"]</code>
2718+
* </p>
2719+
* </li>
2720+
* <li>
2721+
* <p>
2722+
* <b>Critical</b>: <code>["9", "10"]</code>
27182723
* </p>
27192724
* </li>
27202725
* </ul>
2721-
* <p>For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html#guardduty_findings-severity">Severity
2722-
* levels for GuardDuty findings</a>.</p>
2726+
* <p>For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html">Findings severity levels</a>
2727+
* in the <i>Amazon GuardDuty User Guide</i>.</p>
27232728
* </li>
27242729
* <li>
27252730
* <p>type</p>
@@ -4159,12 +4164,12 @@ export interface TriggerDetails {
41594164
}
41604165

41614166
/**
4162-
* <p>Contains information about a malware scan.</p>
4167+
* <p>Contains information about malware scans associated with GuardDuty Malware Protection for EC2.</p>
41634168
* @public
41644169
*/
41654170
export interface Scan {
41664171
/**
4167-
* <p>The unique ID of the detector that the request is associated with.</p>
4172+
* <p>The unique ID of the detector that is associated with the request.</p>
41684173
* <p>To find the <code>detectorId</code> in the current Region, see the
41694174
* Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
41704175
* @public
@@ -4194,7 +4199,7 @@ export interface Scan {
41944199
ScanStatus?: ScanStatus | undefined;
41954200

41964201
/**
4197-
* <p>Represents the reason for FAILED scan status.</p>
4202+
* <p>Represents the reason for <code>FAILED</code> scan status.</p>
41984203
* @public
41994204
*/
42004205
FailureReason?: string | undefined;
@@ -4265,7 +4270,7 @@ export interface Scan {
42654270
*/
42664271
export interface DescribeMalwareScansResponse {
42674272
/**
4268-
* <p>Contains information about malware scans.</p>
4273+
* <p>Contains information about malware scans associated with GuardDuty Malware Protection for EC2.</p>
42694274
* @public
42704275
*/
42714276
Scans: Scan[] | undefined;
@@ -4452,7 +4457,7 @@ export type OrgFeatureAdditionalConfiguration =
44524457
export interface OrganizationAdditionalConfigurationResult {
44534458
/**
44544459
* <p>The name of the additional configuration that is configured for the member accounts within
4455-
* the organization.</p>
4460+
* the organization. These values are applicable to only Runtime Monitoring protection plan.</p>
44564461
* @public
44574462
*/
44584463
Name?: OrgFeatureAdditionalConfiguration | undefined;

clients/client-guardduty/src/models/models_1.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2547,12 +2547,13 @@ export interface OrganizationDataSourceConfigurations {
25472547

25482548
/**
25492549
* <p>A list of additional configurations which will be configured for the organization. </p>
2550+
* <p>Additional configuration applies to only GuardDuty Runtime Monitoring protection plan.</p>
25502551
* @public
25512552
*/
25522553
export interface OrganizationAdditionalConfiguration {
25532554
/**
25542555
* <p>The name of the additional configuration that will be configured for the
2555-
* organization.</p>
2556+
* organization. These values are applicable to only Runtime Monitoring protection plan.</p>
25562557
* @public
25572558
*/
25582559
Name?: OrgFeatureAdditionalConfiguration | undefined;
@@ -2652,7 +2653,9 @@ export interface UpdateOrganizationConfigurationRequest {
26522653
/**
26532654
* @deprecated
26542655
*
2655-
* <p>Represents whether or not to automatically enable member accounts in the organization.</p>
2656+
* <p>Represents whether to automatically enable member accounts in the organization. This
2657+
* applies to only new member accounts, not the existing member accounts. When a new account joins the organization,
2658+
* the chosen features will be enabled for them by default.</p>
26562659
* <p>Even though this is still supported, we recommend using
26572660
* <code>AutoEnableOrganizationMembers</code> to achieve the similar results. You must provide a
26582661
* value for either <code>autoEnableOrganizationMembers</code> or <code>autoEnable</code>.</p>

0 commit comments

Comments
 (0)