From 5f15b8235f9707d8b01291a2e9cf6e8d47e6dcd2 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 22 Sep 2023 18:19:58 +0000 Subject: [PATCH] feat(client-guardduty): Add `EKS_CLUSTER_NAME` to filter and sort key. --- .../DisableOrganizationAdminAccountCommand.ts | 2 +- .../commands/GetCoverageStatisticsCommand.ts | 2 +- .../src/commands/InviteMembersCommand.ts | 2 +- .../src/commands/ListCoverageCommand.ts | 4 +- .../ListOrganizationAdminAccountsCommand.ts | 4 +- .../commands/ListTagsForResourceCommand.ts | 2 +- .../UpdateOrganizationConfigurationCommand.ts | 3 +- .../client-guardduty/src/models/models_0.ts | 29 ++++++++---- .../client-guardduty/src/models/models_1.ts | 22 +++++----- codegen/sdk-codegen/aws-models/guardduty.json | 44 ++++++++++++------- 10 files changed, 68 insertions(+), 46 deletions(-) diff --git a/clients/client-guardduty/src/commands/DisableOrganizationAdminAccountCommand.ts b/clients/client-guardduty/src/commands/DisableOrganizationAdminAccountCommand.ts index 79018ff34b9a..aff91ce9dccb 100644 --- a/clients/client-guardduty/src/commands/DisableOrganizationAdminAccountCommand.ts +++ b/clients/client-guardduty/src/commands/DisableOrganizationAdminAccountCommand.ts @@ -43,7 +43,7 @@ export interface DisableOrganizationAdminAccountCommandOutput /** * @public *

Removes the existing GuardDuty delegated - * administrator of the organization. Only the organization's management account can run this + * administrator of the organization. Only the organization's management account can run this * API operation.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-guardduty/src/commands/GetCoverageStatisticsCommand.ts b/clients/client-guardduty/src/commands/GetCoverageStatisticsCommand.ts index b446d7929cfa..5c4865d0d514 100644 --- a/clients/client-guardduty/src/commands/GetCoverageStatisticsCommand.ts +++ b/clients/client-guardduty/src/commands/GetCoverageStatisticsCommand.ts @@ -52,7 +52,7 @@ export interface GetCoverageStatisticsCommandOutput extends GetCoverageStatistic * FilterCriteria: { // CoverageFilterCriteria * FilterCriterion: [ // CoverageFilterCriterionList * { // CoverageFilterCriterion - * CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE", + * CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE" || "EKS_CLUSTER_NAME", * FilterCondition: { // CoverageFilterCondition * Equals: [ // Equals * "STRING_VALUE", diff --git a/clients/client-guardduty/src/commands/InviteMembersCommand.ts b/clients/client-guardduty/src/commands/InviteMembersCommand.ts index 44ca492c23ab..293c569175e4 100644 --- a/clients/client-guardduty/src/commands/InviteMembersCommand.ts +++ b/clients/client-guardduty/src/commands/InviteMembersCommand.ts @@ -38,7 +38,7 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met /** * @public *

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 + * that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not * needed. For more information, see Managing accounts with organizations.

*

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 diff --git a/clients/client-guardduty/src/commands/ListCoverageCommand.ts b/clients/client-guardduty/src/commands/ListCoverageCommand.ts index 571c8913fb15..279f3de48d55 100644 --- a/clients/client-guardduty/src/commands/ListCoverageCommand.ts +++ b/clients/client-guardduty/src/commands/ListCoverageCommand.ts @@ -54,7 +54,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad * FilterCriteria: { // CoverageFilterCriteria * FilterCriterion: [ // CoverageFilterCriterionList * { // CoverageFilterCriterion - * CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE", + * CriterionKey: "ACCOUNT_ID" || "CLUSTER_NAME" || "RESOURCE_TYPE" || "COVERAGE_STATUS" || "ADDON_VERSION" || "MANAGEMENT_TYPE" || "EKS_CLUSTER_NAME", * FilterCondition: { // CoverageFilterCondition * Equals: [ // Equals * "STRING_VALUE", @@ -67,7 +67,7 @@ export interface ListCoverageCommandOutput extends ListCoverageResponse, __Metad * ], * }, * SortCriteria: { // CoverageSortCriteria - * AttributeName: "ACCOUNT_ID" || "CLUSTER_NAME" || "COVERAGE_STATUS" || "ISSUE" || "ADDON_VERSION" || "UPDATED_AT", + * AttributeName: "ACCOUNT_ID" || "CLUSTER_NAME" || "COVERAGE_STATUS" || "ISSUE" || "ADDON_VERSION" || "UPDATED_AT" || "EKS_CLUSTER_NAME", * OrderBy: "ASC" || "DESC", * }, * }; diff --git a/clients/client-guardduty/src/commands/ListOrganizationAdminAccountsCommand.ts b/clients/client-guardduty/src/commands/ListOrganizationAdminAccountsCommand.ts index a632ab535e20..7d064168ded4 100644 --- a/clients/client-guardduty/src/commands/ListOrganizationAdminAccountsCommand.ts +++ b/clients/client-guardduty/src/commands/ListOrganizationAdminAccountsCommand.ts @@ -42,8 +42,8 @@ export interface ListOrganizationAdminAccountsCommandOutput /** * @public - *

Lists the accounts configured as GuardDuty delegated administrators. - * Only the organization's management account can run this + *

Lists the accounts designated as GuardDuty delegated administrators. + * Only the organization's management account can run this * API operation.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-guardduty/src/commands/ListTagsForResourceCommand.ts b/clients/client-guardduty/src/commands/ListTagsForResourceCommand.ts index 12e6c8ba7a8f..e51fe7ea5d75 100644 --- a/clients/client-guardduty/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-guardduty/src/commands/ListTagsForResourceCommand.ts @@ -38,7 +38,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * @public *

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 resource. + * 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.

* @example diff --git a/clients/client-guardduty/src/commands/UpdateOrganizationConfigurationCommand.ts b/clients/client-guardduty/src/commands/UpdateOrganizationConfigurationCommand.ts index 1007969a047e..4e8e6bb67c5a 100644 --- a/clients/client-guardduty/src/commands/UpdateOrganizationConfigurationCommand.ts +++ b/clients/client-guardduty/src/commands/UpdateOrganizationConfigurationCommand.ts @@ -43,8 +43,7 @@ export interface UpdateOrganizationConfigurationCommandOutput /** * @public *

Configures the delegated administrator account with the provided values. You must provide - * a value for either autoEnableOrganizationMembers or autoEnable, but not - * both.

+ * a value for either autoEnableOrganizationMembers or autoEnable, but not both.

*

There might be regional differences because some data sources might not be * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more * information, see Regions and endpoints.

diff --git a/clients/client-guardduty/src/models/models_0.ts b/clients/client-guardduty/src/models/models_0.ts index 085e87718b96..0bc74fc7e8ad 100644 --- a/clients/client-guardduty/src/models/models_0.ts +++ b/clients/client-guardduty/src/models/models_0.ts @@ -1463,6 +1463,7 @@ export const CoverageFilterCriterionKey = { ADDON_VERSION: "ADDON_VERSION", CLUSTER_NAME: "CLUSTER_NAME", COVERAGE_STATUS: "COVERAGE_STATUS", + EKS_CLUSTER_NAME: "EKS_CLUSTER_NAME", MANAGEMENT_TYPE: "MANAGEMENT_TYPE", RESOURCE_TYPE: "RESOURCE_TYPE", } as const; @@ -1481,6 +1482,10 @@ export interface CoverageFilterCriterion { /** * @public *

An enum value representing possible filter fields.

+ * + *

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. + * CLUSTER_NAME has been deprecated.

+ * */ CriterionKey?: CoverageFilterCriterionKey | string; @@ -1581,6 +1586,7 @@ export const CoverageSortKey = { ADDON_VERSION: "ADDON_VERSION", CLUSTER_NAME: "CLUSTER_NAME", COVERAGE_STATUS: "COVERAGE_STATUS", + EKS_CLUSTER_NAME: "EKS_CLUSTER_NAME", ISSUE: "ISSUE", UPDATED_AT: "UPDATED_AT", } as const; @@ -1612,6 +1618,10 @@ export interface CoverageSortCriteria { /** * @public *

Represents the field name used to sort the coverage details.

+ * + *

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. + * CLUSTER_NAME has been deprecated.

+ * */ AttributeName?: CoverageSortKey | string; @@ -3045,6 +3055,10 @@ export interface FilterCriterion { * @public *

An enum value representing possible scan properties to match with given scan * entries.

+ * + *

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. + * CLUSTER_NAME has been deprecated.

+ * */ CriterionKey?: CriterionKey | string; @@ -4474,7 +4488,7 @@ export interface EksClusterDetails { export interface EnableOrganizationAdminAccountRequest { /** * @public - *

The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated + *

The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated * administrator.

*/ AdminAccountId: string | undefined; @@ -5620,7 +5634,7 @@ export interface Service { /** * @public - *

Contains information about the finding, which is generated when abnormal or suspicious + *

Contains information about the finding that is generated when abnormal or suspicious * activity is detected.

*/ export interface Finding { @@ -6106,22 +6120,19 @@ export type ScanCriterionKey = (typeof ScanCriterionKey)[keyof typeof ScanCriter /** * @public - *

Represents key, value pair to be matched against given resource property.

+ *

Represents the key:value pair to be matched against given resource property.

*/ export interface ScanConditionPair { /** * @public - *

Represents key - * in the map condition.

+ *

Represents the key in the map condition.

*/ Key: string | undefined; /** * @public - *

Represents optional value - * in the map - * condition. If not specified, only key - * will be + *

Represents optional value in the map + * condition. If not specified, only the key will be * matched.

*/ Value?: string; diff --git a/clients/client-guardduty/src/models/models_1.ts b/clients/client-guardduty/src/models/models_1.ts index 39ac389d1d7f..5c8b13fd43a9 100644 --- a/clients/client-guardduty/src/models/models_1.ts +++ b/clients/client-guardduty/src/models/models_1.ts @@ -598,8 +598,9 @@ export interface OrganizationFeatureConfiguration { /** * @public - *

The status of the feature that will be configured for the organization. Use one of the following - * values to configure the feature status for the entire organization:

+ *

Describes the status of the feature that is configured for the + * member accounts within the organization. One of the following + * values is the status for the entire organization:

* */ @@ -645,9 +647,9 @@ export interface UpdateOrganizationConfigurationRequest { * @public * @deprecated * - *

Indicates whether to automatically enable member accounts in the organization.

+ *

Represents whether or not to automatically enable member accounts in the organization.

*

Even though this is still supported, we recommend using - * AutoEnableOrganizationMembers to achieve the similar results. You must provide the + * AutoEnableOrganizationMembers to achieve the similar results. You must provide a * value for either autoEnableOrganizationMembers or autoEnable.

*/ AutoEnable?: boolean; @@ -669,8 +671,7 @@ export interface UpdateOrganizationConfigurationRequest { /** * @public *

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the - * organization. You must provide a - * value for either autoEnableOrganizationMembers or autoEnable.

+ * organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

*

Use one of the * following configuration values for autoEnableOrganizationMembers:

* */ diff --git a/codegen/sdk-codegen/aws-models/guardduty.json b/codegen/sdk-codegen/aws-models/guardduty.json index 1f2f554d77aa..d2a5805c259e 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.json +++ b/codegen/sdk-codegen/aws-models/guardduty.json @@ -1187,7 +1187,7 @@ "CriterionKey": { "target": "com.amazonaws.guardduty#CoverageFilterCriterionKey", "traits": { - "smithy.api#documentation": "

An enum value representing possible filter fields.

", + "smithy.api#documentation": "

An enum value representing possible filter fields.

\n \n

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.

\n ", "smithy.api#jsonName": "criterionKey" } }, @@ -1241,6 +1241,12 @@ "traits": { "smithy.api#enumValue": "MANAGEMENT_TYPE" } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } } } }, @@ -1347,7 +1353,7 @@ "AttributeName": { "target": "com.amazonaws.guardduty#CoverageSortKey", "traits": { - "smithy.api#documentation": "

Represents the field name used to sort the coverage details.

", + "smithy.api#documentation": "

Represents the field name used to sort the coverage details.

\n \n

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.

\n ", "smithy.api#jsonName": "attributeName" } }, @@ -1401,6 +1407,12 @@ "traits": { "smithy.api#enumValue": "UPDATED_AT" } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } } } }, @@ -3571,7 +3583,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.

", + "smithy.api#documentation": "

Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.

", "smithy.api#http": { "method": "POST", "uri": "/admin/disable", @@ -4179,7 +4191,7 @@ "AdminAccountId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.

", + "smithy.api#documentation": "

The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.

", "smithy.api#jsonName": "adminAccountId", "smithy.api#required": {} } @@ -4349,7 +4361,7 @@ "CriterionKey": { "target": "com.amazonaws.guardduty#CriterionKey", "traits": { - "smithy.api#documentation": "

An enum value representing possible scan properties to match with given scan\n entries.

", + "smithy.api#documentation": "

An enum value representing possible scan properties to match with given scan\n entries.

\n \n

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.

\n ", "smithy.api#jsonName": "criterionKey" } }, @@ -4537,7 +4549,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the finding, which is generated when abnormal or suspicious\n activity is detected.

" + "smithy.api#documentation": "

Contains information about the finding that is generated when abnormal or suspicious\n activity is detected.

" } }, "com.amazonaws.guardduty#FindingCriteria": { @@ -7515,7 +7527,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with organizations.

\n

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 Managing GuardDuty accounts \n by invitation.

\n

After the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, 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 CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.

", + "smithy.api#documentation": "

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 manage your GuardDuty environment, this step is not\n needed. For more information, see Managing accounts with organizations.

\n

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 Managing GuardDuty accounts \n by invitation.

\n

After the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, 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 CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", @@ -8747,7 +8759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the accounts configured as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.

", + "smithy.api#documentation": "

Lists the accounts designated as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.

", "smithy.api#http": { "method": "GET", "uri": "/admin", @@ -8915,7 +8927,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.

", + "smithy.api#documentation": "

Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9999,7 +10011,7 @@ "AutoEnable": { "target": "com.amazonaws.guardduty#OrgFeatureStatus", "traits": { - "smithy.api#documentation": "

The status of the feature that will be configured for the organization. Use one of the following \n values to configure the feature status for the entire organization:

\n ", + "smithy.api#documentation": "

Describes the status of the feature that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:

\n ", "smithy.api#jsonName": "autoEnable" } }, @@ -11278,7 +11290,7 @@ "Key": { "target": "com.amazonaws.guardduty#TagKey", "traits": { - "smithy.api#documentation": "

Represents key\n in the map condition.

", + "smithy.api#documentation": "

Represents the key in the map condition.

", "smithy.api#jsonName": "key", "smithy.api#required": {} } @@ -11286,13 +11298,13 @@ "Value": { "target": "com.amazonaws.guardduty#TagValue", "traits": { - "smithy.api#documentation": "

Represents optional value\n in the map\n condition. If not specified, only key\n will be\n matched.

", + "smithy.api#documentation": "

Represents optional value in the map\n condition. If not specified, only the key will be\n matched.

", "smithy.api#jsonName": "value" } } }, "traits": { - "smithy.api#documentation": "

Represents key, value pair to be matched against given resource property.

" + "smithy.api#documentation": "

Represents the key:value pair to be matched against given resource property.

" } }, "com.amazonaws.guardduty#ScanCriterion": { @@ -13061,7 +13073,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not \n both.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", + "smithy.api#documentation": "

Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/admin", @@ -13088,7 +13100,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" }, - "smithy.api#documentation": "

Indicates whether to automatically enable member accounts in the organization.

\n

Even though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide the \n value for either autoEnableOrganizationMembers or autoEnable.

", + "smithy.api#documentation": "

Represents whether or not to automatically enable member accounts in the organization.

\n

Even though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.

", "smithy.api#jsonName": "autoEnable" } }, @@ -13112,7 +13124,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.

\n

Use one of the \n following configuration values for autoEnableOrganizationMembers:

\n ", + "smithy.api#documentation": "

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

\n

Use one of the \n following configuration values for autoEnableOrganizationMembers:

\n ", "smithy.api#jsonName": "autoEnableOrganizationMembers" } }