Skip to content

Commit

Permalink
feat(client-guardduty): Add managementType field to ListCoverage AP…
Browse files Browse the repository at this point in the history
…I response.
  • Loading branch information
awstools committed Sep 13, 2023
1 parent e2e5791 commit 1da1226
Show file tree
Hide file tree
Showing 23 changed files with 310 additions and 154 deletions.
4 changes: 2 additions & 2 deletions clients/client-guardduty/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ been used, or unusual API calls like a password policy change to reduce password
<p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
information, see the <i>
<a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
Guide</a>
<a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
GuardDuty User Guide</a>
</i>. </p>

## Installing
Expand Down
4 changes: 2 additions & 2 deletions clients/client-guardduty/src/GuardDuty.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1396,8 +1396,8 @@ export interface GuardDuty {
* <p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
* findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
* information, see the <i>
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
* Guide</a>
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
* GuardDuty User Guide</a>
* </i>. </p>
*/
export class GuardDuty extends GuardDutyClient implements GuardDuty {}
Expand Down
4 changes: 2 additions & 2 deletions clients/client-guardduty/src/GuardDutyClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -557,8 +557,8 @@ export interface GuardDutyClientResolvedConfig extends GuardDutyClientResolvedCo
* <p>GuardDuty informs you about the status of your Amazon Web Services environment by producing security
* findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
* information, see the <i>
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User
* Guide</a>
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon
* GuardDuty User Guide</a>
* </i>. </p>
*/
export class GuardDutyClient extends __Client<
Expand Down
20 changes: 10 additions & 10 deletions clients/client-guardduty/src/commands/CreateMembersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
* IDs. This step is a prerequisite for managing the associated member accounts either by
* invitation or through an organization.</p>
* <p>As a delegated administrator, using <code>CreateMembers</code> will enable GuardDuty in
* the added member accounts, with the exception of the organization delegated administrator
* account. A delegated administrator must enable GuardDuty prior to being added as a
* member.</p>
* the added member accounts, with the exception of the
* organization delegated administrator account. A delegated administrator must enable GuardDuty
* prior to being added as a member.</p>
* <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
* <code>CreateMembers</code> after GuardDuty has been enabled in potential member accounts.</p>
* <p>If you disassociate a member from a GuardDuty delegated administrator, the member account
* details obtained from this API, including the associated email addresses, will be retained.
* 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 remove the details associated with a member
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.
* </p>
* <code>CreateMembers</code> after GuardDuty has been enabled in potential member accounts.</p>
* <p>If you disassociate a member from a GuardDuty
* delegated administrator, the member account details
* obtained from this API, including the associated email addresses, will be retained.
* 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
* remove the details associated with a member account, the delegated administrator must invoke the
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </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 @@ -41,8 +41,9 @@ export interface DisableOrganizationAdminAccountCommandOutput

/**
* @public
* <p>Disables an Amazon Web Services account within the Organization as the GuardDuty delegated
* administrator.</p>
* <p>Removes the existing GuardDuty delegated
* administrator of the organization. Only the organization's management account can run this
* API operation.</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 @@ -45,12 +45,12 @@ export interface DisassociateFromAdministratorAccountCommandOutput
/**
* @public
* <p>Disassociates the current GuardDuty member account from its administrator account.</p>
* <p>When you disassociate an invited member from a GuardDuty delegated administrator, the member
* account details 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 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 remove the details associated with a member
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
* <p>When you
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
* 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
* 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
* remove the details associated with a member account, the delegated administrator must invoke the
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
* <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to
* <code>ALL</code>, you'll receive an error if you attempt to disable GuardDuty in a member
* account.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ export interface DisassociateFromMasterAccountCommandOutput
* @deprecated
*
* <p>Disassociates the current GuardDuty member account from its administrator account.</p>
* <p>When you disassociate an invited member from a GuardDuty delegated administrator, the member
* account details 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 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 remove the details associated with a member
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.</p>
* <p>When you
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
* 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
* 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
* remove the details associated with a member account, the delegated administrator must invoke the
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API.</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 @@ -36,17 +36,17 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes

/**
* @public
* <p>Disassociates GuardDuty member accounts (from the current administrator account)
* specified by the account IDs.</p>
* <p>When you disassociate an invited member from a GuardDuty delegated administrator, the member
* account details 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 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 remove the details associated with a member
* account, the delegated administrator must invoke the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
* <p>Disassociates GuardDuty member accounts (from the current administrator account) specified
* by the account IDs.</p>
* <p>When you
* disassociate an invited member from a GuardDuty delegated administrator, the member account details
* 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
* 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
* remove the details associated with a member account, the delegated administrator must invoke the
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html">DeleteMembers</a> API. </p>
* <p>With <code>autoEnableOrganizationMembers</code> configuration for your organization set to
* <code>ALL</code>, you'll receive an error if you attempt to disassociate a member account
* before removing them from your Amazon Web Services organization.</p>
* before removing them from your organization.</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 @@ -41,8 +41,9 @@ export interface EnableOrganizationAdminAccountCommandOutput

/**
* @public
* <p>Enables an Amazon Web Services account within the organization as the GuardDuty delegated
* administrator.</p>
* <p>Designates an Amazon Web Services account within the organization as your GuardDuty delegated
* administrator. Only the organization's management account can run this
* API operation.</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 @@ -36,8 +36,12 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc

/**
* @public
* <p>Provides the details for the GuardDuty administrator account associated with the current
* <p>Provides the details of the GuardDuty administrator account associated with the current
* GuardDuty member account.</p>
* <note>
* <p>If the organization's management account or a delegated administrator runs this API,
* it will return success (<code>HTTP 200</code>) but no content.</p>
* </note>
* @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 @@ -51,7 +51,7 @@ export interface GetCoverageStatisticsCommandOutput extends GetCoverageStatistic
* FilterCriteria: { // CoverageFilterCriteria
* FilterCriterion: [ // CoverageFilterCriterionList
* { // CoverageFilterCriterion
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION",
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE",
* FilterCondition: { // CoverageFilterCondition
* Equals: [ // Equals
* "STRING_VALUE",
Expand Down
34 changes: 18 additions & 16 deletions clients/client-guardduty/src/commands/InviteMembersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,24 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met

/**
* @public
* <p>Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services
* account that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty
* 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
* Organizations</a>.</p>
* <p>To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the
* potential member accounts. You can now invoke this API to add accounts by invitation. The
* invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each
* invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For
* more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html">Managing GuardDuty accounts by
* invitation</a>.</p>
* <p>After the invite has been accepted and you choose to disassociate a member account (by
* 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
* invoking <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a>, including
* the associated email addresses, will be retained. This is done so that you can invoke
* InviteMembers without the need to invoke <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> again. To
* 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>
* <p>Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account
* that invokes this API. If you are using organizations to manager your GuardDuty 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 organizations</a>.</p>
* <p>To invite Amazon Web Services accounts, the first step is
* to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API
* to add accounts by invitation. The
* invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can
* choose to accept the invitation from only one Amazon Web Services account. For more information, see
* <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html">Managing GuardDuty accounts
* by invitation</a>.</p>
* <p>After the invite has been accepted and you choose to disassociate a member account
* (by 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 invoking <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a>, including the
* associated email addresses, will be retained.
* This is done so that you can invoke InviteMembers without the need to invoke
* <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">CreateMembers</a> again. To
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 2 additions & 1 deletion clients/client-guardduty/src/commands/ListCoverageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad
* FilterCriteria: { // CoverageFilterCriteria
* FilterCriterion: [ // CoverageFilterCriterionList
* { // CoverageFilterCriterion
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION",
* CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE",
* FilterCondition: { // CoverageFilterCondition
* Equals: [ // Equals
* "STRING_VALUE",
Expand Down Expand Up @@ -87,6 +87,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad
* // AddonVersion: "STRING_VALUE",
* // AddonStatus: "STRING_VALUE",
* // },
* // ManagementType: "AUTO_MANAGED" || "MANUAL",
* // },
* // ResourceType: "EKS",
* // },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ export interface ListOrganizationAdminAccountsCommandOutput

/**
* @public
* <p>Lists the accounts configured as GuardDuty delegated administrators.</p>
* <p>Lists the accounts configured as GuardDuty delegated administrators.
* Only the organization's management account can run this
* API operation.</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 @@ -37,8 +37,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
/**
* @public
* <p>Lists tags for a resource. Tagging is currently supported for detectors, finding filters,
* IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per each
* resource. When invoked, this operation returns all assigned tags for a given resource.</p>
* IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource.
* When invoked, this
* operation returns all assigned tags for a given resource.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 1da1226

Please sign in to comment.