Skip to content

Commit 4d6362d

Browse files
author
awstools
committed
docs(client-detective): Doc only updates for content enhancement
1 parent f8844a4 commit 4d6362d

15 files changed

+134
-151
lines changed

clients/client-detective/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ accounts in the organization behavior graph.</p>
7777
</ul>
7878
<p>All API actions are logged as CloudTrail events. See <a href="https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html">Logging Detective API Calls with CloudTrail</a>.</p>
7979
<note>
80-
<p>We replaced the term "master account" with the term "administrator account." An
80+
<p>We replaced the term "master account" with the term "administrator account". An
8181
administrator account is used to centrally manage multiple accounts. In the case of
8282
Detective, the administrator account manages the accounts in their behavior
8383
graph.</p>

clients/client-detective/src/Detective.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ export interface Detective {
665665
* </ul>
666666
* <p>All API actions are logged as CloudTrail events. See <a href="https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html">Logging Detective API Calls with CloudTrail</a>.</p>
667667
* <note>
668-
* <p>We replaced the term "master account" with the term "administrator account." An
668+
* <p>We replaced the term "master account" with the term "administrator account". An
669669
* administrator account is used to centrally manage multiple accounts. In the case of
670670
* Detective, the administrator account manages the accounts in their behavior
671671
* graph.</p>

clients/client-detective/src/DetectiveClient.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ export interface DetectiveClientResolvedConfig extends DetectiveClientResolvedCo
444444
* </ul>
445445
* <p>All API actions are logged as CloudTrail events. See <a href="https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html">Logging Detective API Calls with CloudTrail</a>.</p>
446446
* <note>
447-
* <p>We replaced the term "master account" with the term "administrator account." An
447+
* <p>We replaced the term "master account" with the term "administrator account". An
448448
* administrator account is used to centrally manage multiple accounts. In the case of
449449
* Detective, the administrator account manages the accounts in their behavior
450450
* graph.</p>

clients/client-detective/src/commands/CreateGraphCommand.ts

+4-15
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,6 @@ export interface CreateGraphCommandOutput extends CreateGraphResponse, __Metadat
3030
* @public
3131
* <p>Creates a new behavior graph for the calling account, and sets that account as the
3232
* administrator account. This operation is called by the account that is enabling Detective.</p>
33-
* <p>Before you try to enable Detective, make sure that your account has been
34-
* enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this
35-
* requirement, you cannot enable Detective. If you do meet the GuardDuty
36-
* prerequisite, then when you make the request to enable Detective, it checks
37-
* whether your data volume is within the Detective quota. If it exceeds the quota,
38-
* then you cannot enable Detective. </p>
3933
* <p>The operation also enables Detective for the calling account in the currently
4034
* selected Region. It returns the ARN of the new behavior graph.</p>
4135
* <p>
@@ -83,17 +77,12 @@ export interface CreateGraphCommandOutput extends CreateGraphResponse, __Metadat
8377
* <p>This request cannot be completed for one of the following reasons.</p>
8478
* <ul>
8579
* <li>
86-
* <p>The request would cause the number of member accounts in the behavior graph to
87-
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
88-
* accounts.</p>
80+
* <p>This request cannot be completed if it would cause the number of member accounts in the
81+
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
82+
* member accounts.</p>
8983
* </li>
9084
* <li>
91-
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
92-
* allowed.</p>
93-
* </li>
94-
* <li>
95-
* <p>Detective is unable to verify the data rate for the member account. This
96-
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
85+
* <p>This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.</p>
9786
* </li>
9887
* </ul>
9988
*

clients/client-detective/src/commands/CreateMembersCommand.ts

+4-9
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,12 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
142142
* <p>This request cannot be completed for one of the following reasons.</p>
143143
* <ul>
144144
* <li>
145-
* <p>The request would cause the number of member accounts in the behavior graph to
146-
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
147-
* accounts.</p>
145+
* <p>This request cannot be completed if it would cause the number of member accounts in the
146+
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
147+
* member accounts.</p>
148148
* </li>
149149
* <li>
150-
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
151-
* allowed.</p>
152-
* </li>
153-
* <li>
154-
* <p>Detective is unable to verify the data rate for the member account. This
155-
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
150+
* <p>This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.</p>
156151
* </li>
157152
* </ul>
158153
*

clients/client-detective/src/commands/GetInvestigationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetInvestigationCommandOutput extends GetInvestigationResponse,
2828

2929
/**
3030
* @public
31-
* <p>Returns the investigation results of an investigation for a behavior graph. </p>
31+
* <p>Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. <code>GetInvestigation</code> returns the investigation results of an investigation for a behavior graph. </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-detective/src/commands/ListIndicatorsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListIndicatorsCommandOutput extends ListIndicatorsResponse, __M
2828

2929
/**
3030
* @public
31-
* <p>Get the indicators from an investigation</p>
31+
* <p>Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-detective/src/commands/ListInvestigationsCommand.ts

+6-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ export interface ListInvestigationsCommandOutput extends ListInvestigationsRespo
2828

2929
/**
3030
* @public
31-
* <p>List all Investigations.</p>
31+
* <p>Detective investigations lets you investigate IAM users and
32+
* IAM roles using indicators of compromise. An indicator of compromise
33+
* (IOC) is an artifact observed in or on a network, system, or environment that can (with a
34+
* high level of confidence) identify malicious activity or a security incident.
35+
* <code>ListInvestigations</code> lists all active Detective
36+
* investigations.</p>
3237
* @example
3338
* Use a bare-bones client and the command you need to make an API call.
3439
* ```javascript

clients/client-detective/src/commands/StartInvestigationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface StartInvestigationCommandOutput extends StartInvestigationRespo
2828

2929
/**
3030
* @public
31-
* <p>initiate an investigation on an entity in a graph</p>
31+
* <p>Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. <code>StartInvestigation</code> initiates an investigation on an entity in a behavior graph. </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-detective/src/commands/StartMonitoringMemberCommand.ts

+4-9
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,12 @@ export interface StartMonitoringMemberCommandOutput extends __MetadataBearer {}
8080
* <p>This request cannot be completed for one of the following reasons.</p>
8181
* <ul>
8282
* <li>
83-
* <p>The request would cause the number of member accounts in the behavior graph to
84-
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
85-
* accounts.</p>
83+
* <p>This request cannot be completed if it would cause the number of member accounts in the
84+
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
85+
* member accounts.</p>
8686
* </li>
8787
* <li>
88-
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
89-
* allowed.</p>
90-
* </li>
91-
* <li>
92-
* <p>Detective is unable to verify the data rate for the member account. This
93-
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
88+
* <p>This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.</p>
9489
* </li>
9590
* </ul>
9691
*

clients/client-detective/src/commands/UpdateDatasourcePackagesCommand.ts

+4-9
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,12 @@ export interface UpdateDatasourcePackagesCommandOutput extends __MetadataBearer
6767
* <p>This request cannot be completed for one of the following reasons.</p>
6868
* <ul>
6969
* <li>
70-
* <p>The request would cause the number of member accounts in the behavior graph to
71-
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
72-
* accounts.</p>
70+
* <p>This request cannot be completed if it would cause the number of member accounts in the
71+
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
72+
* member accounts.</p>
7373
* </li>
7474
* <li>
75-
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
76-
* allowed.</p>
77-
* </li>
78-
* <li>
79-
* <p>Detective is unable to verify the data rate for the member account. This
80-
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
75+
* <p>This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.</p>
8176
* </li>
8277
* </ul>
8378
*

clients/client-detective/src/commands/UpdateInvestigationStateCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdateInvestigationStateCommandOutput extends __MetadataBearer
2828

2929
/**
3030
* @public
31-
* <p>Update the state of an investigation.</p>
31+
* <p>Updates the state of an investigation.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-detective/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
* </ul>
7373
* <p>All API actions are logged as CloudTrail events. See <a href="https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html">Logging Detective API Calls with CloudTrail</a>.</p>
7474
* <note>
75-
* <p>We replaced the term "master account" with the term "administrator account." An
75+
* <p>We replaced the term "master account" with the term "administrator account". An
7676
* administrator account is used to centrally manage multiple accounts. In the case of
7777
* Detective, the administrator account manages the accounts in their behavior
7878
* graph.</p>

0 commit comments

Comments
 (0)