Skip to content

Commit 3d11530

Browse files
author
awstools
committed
docs(client-guardduty): Updated descriptions for some APIs.
1 parent a7c47ab commit 3d11530

File tree

7 files changed

+56
-17
lines changed

7 files changed

+56
-17
lines changed

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,18 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
3939
* <p>Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account
4040
* IDs. This step is a prerequisite for managing the associated member accounts either by
4141
* invitation or through an organization.</p>
42-
* <p>When using <code>Create Members</code> as an organizations delegated administrator this
43-
* action will enable GuardDuty in the added member accounts, with the exception of the
44-
* organization delegated administrator account, which must enable GuardDuty prior to being added
45-
* as a member.</p>
46-
* <p>If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in
47-
* potential member accounts and before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a>.</p>
42+
* <p>As a delegated administrator, using <code>CreateMembers</code> will enable GuardDuty in
43+
* the added member accounts, with the exception of the
44+
* organization delegated administrator account. A delegated administrator must enable GuardDuty
45+
* prior to being added as a member.</p>
46+
* <p>If you are adding accounts by invitation, before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a>, use
47+
* <code>CreateMembers</code> after GuardDuty has been enabled in potential member accounts.</p>
48+
* <p>If you disassociate a member from a GuardDuty
49+
* delegated administrator, the member account details
50+
* obtained from this API, including the associated email addresses, will be retained.
51+
* This is done so that the delegated administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without the need to invoke the CreateMembers API again. To
52+
* remove the details associated with a member account, the delegated administrator must invoke the
53+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
4854
* @example
4955
* Use a bare-bones client and the command you need to make an API call.
5056
* ```javascript

clients/client-guardduty/src/commands/DisassociateFromAdministratorAccountCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ export interface DisassociateFromAdministratorAccountCommandOutput
4545
/**
4646
* @public
4747
* <p>Disassociates the current GuardDuty member account from its administrator account.</p>
48+
* <p>When you
49+
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
50+
* obtained from the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> API, including the associated email addresses, are retained. This is
51+
* done so that the delegated administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without the need to invoke the CreateMembers API again. To
52+
* remove the details associated with a member account, the delegated administrator must invoke the
53+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
4854
* <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to
4955
* <code>ALL</code>, you'll receive an error if you attempt to disable GuardDuty in a member
5056
* account.</p>

clients/client-guardduty/src/commands/DisassociateFromMasterAccountCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ export interface DisassociateFromMasterAccountCommandOutput
4444
* @deprecated
4545
*
4646
* <p>Disassociates the current GuardDuty member account from its administrator account.</p>
47+
* <p>When you
48+
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
49+
* obtained from the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> API, including the associated email addresses, are retained. This is
50+
* done so that the delegated administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without the need to invoke the CreateMembers API again. To
51+
* remove the details associated with a member account, the delegated administrator must invoke the
52+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.</p>
4753
* @example
4854
* Use a bare-bones client and the command you need to make an API call.
4955
* ```javascript

clients/client-guardduty/src/commands/DisassociateMembersCommand.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,14 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
3636

3737
/**
3838
* @public
39-
* <p>Disassociates GuardDuty member accounts (to the current administrator account) specified
39+
* <p>Disassociates GuardDuty member accounts (from the current administrator account) specified
4040
* by the account IDs.</p>
41+
* <p>When you
42+
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
43+
* obtained from the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> API, including the associated email addresses, are retained. This is
44+
* done so that the delegated administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without the need to invoke the CreateMembers API again. To
45+
* remove the details associated with a member account, the delegated administrator must invoke the
46+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
4147
* <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to
4248
* <code>ALL</code>, you'll receive an error if you attempt to disassociate a member account
4349
* before removing them from your Amazon Web Services organization.</p>

clients/client-guardduty/src/commands/InviteMembersCommand.ts

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,24 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met
3636

3737
/**
3838
* @public
39-
* <p>Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by
40-
* CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage
41-
* these accounts' findings on their behalf as the GuardDuty administrator account.</p>
39+
* <p>Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account
40+
* that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty environment, this step is not
41+
* needed. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html">Managing accounts with Amazon Web Services Organizations</a>.</p>
42+
* <p>To invite Amazon Web Services accounts, the first step is
43+
* to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API
44+
* to add accounts by invitation. The
45+
* invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can
46+
* choose to accept the invitation from only one Amazon Web Services account. For more information, see
47+
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html">Managing GuardDuty accounts
48+
* by invitation</a>.</p>
49+
* <p>After the invite has been accepted and you choose to disassociate a member account
50+
* (by using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DisassociateMembers.html">DisassociateMembers</a>) from your account,
51+
* the details of the member account obtained by invoking <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a>, including the
52+
* associated email addresses, will be retained.
53+
* This is done so that you can invoke InviteMembers without the need to invoke
54+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> again. To
55+
* remove the details associated with a member account, you must also invoke
56+
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a>. </p>
4257
* @example
4358
* Use a bare-bones client and the command you need to make an API call.
4459
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ export interface AwsApiCallAction {
572572
*/
573573
export interface DnsRequestAction {
574574
/**
575-
* <p>The domain information for the API request.</p>
575+
* <p>The domain information for the DNS query.</p>
576576
*/
577577
Domain?: string;
578578

codegen/sdk-codegen/aws-models/guardduty.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1790,7 +1790,7 @@
17901790
}
17911791
],
17921792
"traits": {
1793-
"smithy.api#documentation": "<p>Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.</p>\n <p>When using <code>Create Members</code> as an organizations delegated administrator this\n action will enable GuardDuty in the added member accounts, with the exception of the\n organization delegated administrator account, which must enable GuardDuty prior to being added\n as a member.</p>\n <p>If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in\n potential member accounts and before using <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a>.</p>",
1793+
"smithy.api#documentation": "<p>Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.</p>\n <p>As a delegated administrator, using <code>CreateMembers</code> will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.</p>\n <p>If you are adding accounts by invitation, before using <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a>, use \n <code>CreateMembers</code> after GuardDuty has been enabled in potential member accounts.</p>\n <p>If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a> API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html\">DeleteMembers</a> API. </p>",
17941794
"smithy.api#http": {
17951795
"method": "POST",
17961796
"uri": "/detector/{DetectorId}/member",
@@ -3606,7 +3606,7 @@
36063606
}
36073607
],
36083608
"traits": {
3609-
"smithy.api#documentation": "<p>Disassociates the current GuardDuty member account from its administrator account.</p>\n <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to\n <code>ALL</code>, you'll receive an error if you attempt to disable GuardDuty in a member\n account.</p>",
3609+
"smithy.api#documentation": "<p>Disassociates the current GuardDuty member account from its administrator account.</p>\n <p>When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html\">CreateMembers</a> API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a> API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html\">DeleteMembers</a> API. </p>\n <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to\n <code>ALL</code>, you'll receive an error if you attempt to disable GuardDuty in a member\n account.</p>",
36103610
"smithy.api#http": {
36113611
"method": "POST",
36123612
"uri": "/detector/{DetectorId}/administrator/disassociate",
@@ -3658,7 +3658,7 @@
36583658
"smithy.api#deprecated": {
36593659
"message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead"
36603660
},
3661-
"smithy.api#documentation": "<p>Disassociates the current GuardDuty member account from its administrator account.</p>",
3661+
"smithy.api#documentation": "<p>Disassociates the current GuardDuty member account from its administrator account.</p>\n <p>When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html\">CreateMembers</a> API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a> API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html\">DeleteMembers</a> API.</p>",
36623662
"smithy.api#http": {
36633663
"method": "POST",
36643664
"uri": "/detector/{DetectorId}/master/disassociate",
@@ -3713,7 +3713,7 @@
37133713
}
37143714
],
37153715
"traits": {
3716-
"smithy.api#documentation": "<p>Disassociates GuardDuty member accounts (to the current administrator account) specified\n by the account IDs.</p>\n <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to\n <code>ALL</code>, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.</p>",
3716+
"smithy.api#documentation": "<p>Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.</p>\n <p>When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html\">CreateMembers</a> API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html\">InviteMembers</a> API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html\">DeleteMembers</a> API. </p>\n <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to\n <code>ALL</code>, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.</p>",
37173717
"smithy.api#http": {
37183718
"method": "POST",
37193719
"uri": "/detector/{DetectorId}/member/disassociate",
@@ -3768,7 +3768,7 @@
37683768
"Domain": {
37693769
"target": "com.amazonaws.guardduty#String",
37703770
"traits": {
3771-
"smithy.api#documentation": "<p>The domain information for the API request.</p>",
3771+
"smithy.api#documentation": "<p>The domain information for the DNS query.</p>",
37723772
"smithy.api#jsonName": "domain"
37733773
}
37743774
},
@@ -7538,7 +7538,7 @@
75387538
}
75397539
],
75407540
"traits": {
7541-
"smithy.api#documentation": "<p>Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by\n CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage\n these accounts' findings on their behalf as the GuardDuty administrator account.</p>",
7541+
"smithy.api#documentation": "<p>Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html\">Managing accounts with Amazon Web Services Organizations</a>.</p>\n <p>To invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html\">Managing GuardDuty accounts \n by invitation</a>.</p>\n <p>After the invite has been accepted and you choose to disassociate a member account \n (by using <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DisassociateMembers.html\">DisassociateMembers</a>) from your account, \n the details of the member account obtained by invoking <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html\">CreateMembers</a>, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html\">CreateMembers</a> again. To \n remove the details associated with a member account, you must also invoke \n <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html\">DeleteMembers</a>. </p>",
75427542
"smithy.api#http": {
75437543
"method": "POST",
75447544
"uri": "/detector/{DetectorId}/member/invite",

0 commit comments

Comments
 (0)