Skip to content

Commit 1da1226

Browse files
author
awstools
committed
feat(client-guardduty): Add managementType field to ListCoverage API response.
1 parent e2e5791 commit 1da1226

23 files changed

+310
-154
lines changed

clients/client-guardduty/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ been used, or unusual API calls like a password policy change to reduce password
2222
<p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
2323
findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
2424
information, see the <i>
25-
<a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
26-
Guide</a>
25+
<a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
26+
GuardDuty User Guide</a>
2727
</i>. </p>
2828

2929
## Installing

clients/client-guardduty/src/GuardDuty.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,8 +1396,8 @@ export interface GuardDuty {
13961396
* <p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
13971397
* findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
13981398
* information, see the <i>
1399-
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
1400-
* Guide</a>
1399+
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
1400+
* GuardDuty User Guide</a>
14011401
* </i>. </p>
14021402
*/
14031403
export class GuardDuty extends GuardDutyClient implements GuardDuty {}

clients/client-guardduty/src/GuardDutyClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,8 +557,8 @@ export interface GuardDutyClientResolvedConfig extends GuardDutyClientResolvedCo
557557
* <p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
558558
* findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
559559
* information, see the <i>
560-
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
561-
* Guide</a>
560+
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
561+
* GuardDuty User Guide</a>
562562
* </i>. </p>
563563
*/
564564
export class GuardDutyClient extends __Client<

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
4040
* IDs. This step is a prerequisite for managing the associated member accounts either by
4141
* invitation or through an organization.</p>
4242
* <p>As a delegated administrator, using <code>CreateMembers</code> will enable GuardDuty in
43-
* the added member accounts, with the exception of the organization delegated administrator
44-
* account. A delegated administrator must enable GuardDuty prior to being added as a
45-
* member.</p>
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>
4646
* <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 delegated administrator, the member account
49-
* details obtained from this API, including the associated email addresses, will be retained.
50-
* 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
51-
* the need to invoke the CreateMembers API again. To remove the details associated with a member
52-
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.
53-
* </p>
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>
5454
* @example
5555
* Use a bare-bones client and the command you need to make an API call.
5656
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ export interface DisableOrganizationAdminAccountCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Disables an Amazon Web Services account within the Organization as the GuardDuty delegated
45-
* administrator.</p>
44+
* <p>Removes the existing GuardDuty delegated
45+
* administrator of the organization. Only the organization's management account can run this
46+
* API operation.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

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

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

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +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 disassociate an invited member from a GuardDuty delegated administrator, the member
48-
* account details obtained from the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> API,
49-
* including the associated email addresses, are retained. This is done so that the delegated
50-
* administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without
51-
* the need to invoke the CreateMembers API again. To remove the details associated with a member
52-
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.</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>
5353
* @example
5454
* Use a bare-bones client and the command you need to make an API call.
5555
* ```javascript

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
3636

3737
/**
3838
* @public
39-
* <p>Disassociates GuardDuty member accounts (from the current administrator account)
40-
* specified by the account IDs.</p>
41-
* <p>When you disassociate an invited member from a GuardDuty delegated administrator, the member
42-
* account details obtained from the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> API,
43-
* including the associated email addresses, are retained. This is done so that the delegated
44-
* administrator can invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a> API without
45-
* the need to invoke the CreateMembers API again. To remove the details associated with a member
46-
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
39+
* <p>Disassociates GuardDuty member accounts (from the current administrator account) specified
40+
* 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>
4747
* <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to
4848
* <code>ALL</code>, you'll receive an error if you attempt to disassociate a member account
49-
* before removing them from your Amazon Web Services organization.</p>
49+
* before removing them from your organization.</p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ export interface EnableOrganizationAdminAccountCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Enables an Amazon Web Services account within the organization as the GuardDuty delegated
45-
* administrator.</p>
44+
* <p>Designates an Amazon Web Services account within the organization as your GuardDuty delegated
45+
* administrator. Only the organization's management account can run this
46+
* API operation.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,12 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
3636

3737
/**
3838
* @public
39-
* <p>Provides the details for the GuardDuty administrator account associated with the current
39+
* <p>Provides the details of the GuardDuty administrator account associated with the current
4040
* GuardDuty member account.</p>
41+
* <note>
42+
* <p>If the organization's management account or a delegated administrator runs this API,
43+
* it will return success (<code>HTTP 200</code>) but no content.</p>
44+
* </note>
4145
* @example
4246
* Use a bare-bones client and the command you need to make an API call.
4347
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export interface GetCoverageStatisticsCommandOutput extends GetCoverageStatistic
5151
* FilterCriteria: { // CoverageFilterCriteria
5252
* FilterCriterion: [ // CoverageFilterCriterionList
5353
* { // CoverageFilterCriterion
54-
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION",
54+
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE",
5555
* FilterCondition: { // CoverageFilterCondition
5656
* Equals: [ // Equals
5757
* "STRING_VALUE",

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

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

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

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad
5353
* FilterCriteria: { // CoverageFilterCriteria
5454
* FilterCriterion: [ // CoverageFilterCriterionList
5555
* { // CoverageFilterCriterion
56-
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION",
56+
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE",
5757
* FilterCondition: { // CoverageFilterCondition
5858
* Equals: [ // Equals
5959
* "STRING_VALUE",
@@ -87,6 +87,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad
8787
* // AddonVersion: "STRING_VALUE",
8888
* // AddonStatus: "STRING_VALUE",
8989
* // },
90+
* // ManagementType: "AUTO_MANAGED" || "MANUAL",
9091
* // },
9192
* // ResourceType: "EKS",
9293
* // },

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ export interface ListOrganizationAdminAccountsCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Lists the accounts configured as GuardDuty delegated administrators.</p>
44+
* <p>Lists the accounts configured as GuardDuty delegated administrators.
45+
* Only the organization's management account can run this
46+
* API operation.</p>
4547
* @example
4648
* Use a bare-bones client and the command you need to make an API call.
4749
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
3737
/**
3838
* @public
3939
* <p>Lists tags for a resource. Tagging is currently supported for detectors, finding filters,
40-
* IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per each
41-
* resource. When invoked, this operation returns all assigned tags for a given resource.</p>
40+
* IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource.
41+
* When invoked, this
42+
* operation returns all assigned tags for a given resource.</p>
4243
* @example
4344
* Use a bare-bones client and the command you need to make an API call.
4445
* ```javascript

0 commit comments

Comments
 (0)