Skip to content

Commit

Permalink
docs(client-detective): Doc only updates for content enhancement
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Feb 15, 2024
1 parent f8844a4 commit 4d6362d
Show file tree
Hide file tree
Showing 15 changed files with 134 additions and 151 deletions.
2 changes: 1 addition & 1 deletion clients/client-detective/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ accounts in the organization behavior graph.</p>
</ul>
<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>
<note>
<p>We replaced the term "master account" with the term "administrator account." An
<p>We replaced the term "master account" with the term "administrator account". An
administrator account is used to centrally manage multiple accounts. In the case of
Detective, the administrator account manages the accounts in their behavior
graph.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-detective/src/Detective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ export interface Detective {
* </ul>
* <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>
* <note>
* <p>We replaced the term "master account" with the term "administrator account." An
* <p>We replaced the term "master account" with the term "administrator account". An
* administrator account is used to centrally manage multiple accounts. In the case of
* Detective, the administrator account manages the accounts in their behavior
* graph.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-detective/src/DetectiveClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ export interface DetectiveClientResolvedConfig extends DetectiveClientResolvedCo
* </ul>
* <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>
* <note>
* <p>We replaced the term "master account" with the term "administrator account." An
* <p>We replaced the term "master account" with the term "administrator account". An
* administrator account is used to centrally manage multiple accounts. In the case of
* Detective, the administrator account manages the accounts in their behavior
* graph.</p>
Expand Down
19 changes: 4 additions & 15 deletions clients/client-detective/src/commands/CreateGraphCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ export interface CreateGraphCommandOutput extends CreateGraphResponse, __Metadat
* @public
* <p>Creates a new behavior graph for the calling account, and sets that account as the
* administrator account. This operation is called by the account that is enabling Detective.</p>
* <p>Before you try to enable Detective, make sure that your account has been
* enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this
* requirement, you cannot enable Detective. If you do meet the GuardDuty
* prerequisite, then when you make the request to enable Detective, it checks
* whether your data volume is within the Detective quota. If it exceeds the quota,
* then you cannot enable Detective. </p>
* <p>The operation also enables Detective for the calling account in the currently
* selected Region. It returns the ARN of the new behavior graph.</p>
* <p>
Expand Down Expand Up @@ -83,17 +77,12 @@ export interface CreateGraphCommandOutput extends CreateGraphResponse, __Metadat
* <p>This request cannot be completed for one of the following reasons.</p>
* <ul>
* <li>
* <p>The request would cause the number of member accounts in the behavior graph to
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
* accounts.</p>
* <p>This request cannot be completed if it would cause the number of member accounts in the
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
* member accounts.</p>
* </li>
* <li>
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
* allowed.</p>
* </li>
* <li>
* <p>Detective is unable to verify the data rate for the member account. This
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
* <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>
* </li>
* </ul>
*
Expand Down
13 changes: 4 additions & 9 deletions clients/client-detective/src/commands/CreateMembersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,17 +142,12 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
* <p>This request cannot be completed for one of the following reasons.</p>
* <ul>
* <li>
* <p>The request would cause the number of member accounts in the behavior graph to
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
* accounts.</p>
* <p>This request cannot be completed if it would cause the number of member accounts in the
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
* member accounts.</p>
* </li>
* <li>
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
* allowed.</p>
* </li>
* <li>
* <p>Detective is unable to verify the data rate for the member account. This
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
* <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>
* </li>
* </ul>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface GetInvestigationCommandOutput extends GetInvestigationResponse,

/**
* @public
* <p>Returns the investigation results of an investigation for a behavior graph. </p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface ListIndicatorsCommandOutput extends ListIndicatorsResponse, __M

/**
* @public
* <p>Get the indicators from an investigation</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ export interface ListInvestigationsCommandOutput extends ListInvestigationsRespo

/**
* @public
* <p>List all Investigations.</p>
* <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>ListInvestigations</code> lists all active Detective
* investigations.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface StartInvestigationCommandOutput extends StartInvestigationRespo

/**
* @public
* <p>initiate an investigation on an entity in a graph</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,12 @@ export interface StartMonitoringMemberCommandOutput extends __MetadataBearer {}
* <p>This request cannot be completed for one of the following reasons.</p>
* <ul>
* <li>
* <p>The request would cause the number of member accounts in the behavior graph to
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
* accounts.</p>
* <p>This request cannot be completed if it would cause the number of member accounts in the
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
* member accounts.</p>
* </li>
* <li>
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
* allowed.</p>
* </li>
* <li>
* <p>Detective is unable to verify the data rate for the member account. This
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
* <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>
* </li>
* </ul>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,12 @@ export interface UpdateDatasourcePackagesCommandOutput extends __MetadataBearer
* <p>This request cannot be completed for one of the following reasons.</p>
* <ul>
* <li>
* <p>The request would cause the number of member accounts in the behavior graph to
* exceed the maximum allowed. A behavior graph cannot have more than 1200 member
* accounts.</p>
* <p>This request cannot be completed if it would cause the number of member accounts in the
* behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200
* member accounts.</p>
* </li>
* <li>
* <p>The request would cause the data rate for the behavior graph to exceed the maximum
* allowed.</p>
* </li>
* <li>
* <p>Detective is unable to verify the data rate for the member account. This
* is usually because the member account is not enrolled in Amazon GuardDuty.</p>
* <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>
* </li>
* </ul>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface UpdateInvestigationStateCommandOutput extends __MetadataBearer

/**
* @public
* <p>Update the state of an investigation.</p>
* <p>Updates the state of an investigation.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-detective/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
* </ul>
* <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>
* <note>
* <p>We replaced the term "master account" with the term "administrator account." An
* <p>We replaced the term "master account" with the term "administrator account". An
* administrator account is used to centrally manage multiple accounts. In the case of
* Detective, the administrator account manages the accounts in their behavior
* graph.</p>
Expand Down
Loading

0 comments on commit 4d6362d

Please sign in to comment.