Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search +
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results
Applying, editing, and removing tags from resource groups
*Resolving resource group member ARNs so they can be returned as search + *
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search * results
*Applying, editing, and removing tags from resource groups
*Resolving resource group member ARNs so they can be returned as search + *
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search * results
*Cancels the specified tag-sync task.
+ *+ * Minimum permissions + *
+ *To run this command, you must have the following permissions:
+ *
+ * resource-groups:CancelTagSyncTask on the application group
+ * resource-groups:DeleteGroup
+ *
The request includes one or more parameters that violate validation rules.
+ * + * @throws {@link ForbiddenException} (client fault) + *The caller isn't authorized to make the request. Check permissions.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *An internal error occurred while processing the request. Try again later.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *The request uses an HTTP method that isn't allowed for the specified resource.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *You've exceeded throttling limits by making too many requests in a period of + * time.
+ * + * @throws {@link UnauthorizedException} (client fault) + *The request was rejected because it doesn't have valid credentials for the target + * resource.
+ * + * @throws {@link ResourceGroupsServiceException} + *Base exception class for all service exceptions from ResourceGroups service.
+ * + * @public + */ +export class CancelTagSyncTaskCommand extends $Command + .classBuilder< + CancelTagSyncTaskCommandInput, + CancelTagSyncTaskCommandOutput, + ResourceGroupsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceGroupsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Ardi", "CancelTagSyncTask", {}) + .n("ResourceGroupsClient", "CancelTagSyncTaskCommand") + .f(void 0, void 0) + .ser(se_CancelTagSyncTaskCommand) + .de(de_CancelTagSyncTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CancelTagSyncTaskInput; + output: {}; + }; + sdk: { + input: CancelTagSyncTaskCommandInput; + output: CancelTagSyncTaskCommandOutput; + }; + }; +} diff --git a/clients/client-resource-groups/src/commands/CreateGroupCommand.ts b/clients/client-resource-groups/src/commands/CreateGroupCommand.ts index feabbe1ee21a..75600b339641 100644 --- a/clients/client-resource-groups/src/commands/CreateGroupCommand.ts +++ b/clients/client-resource-groups/src/commands/CreateGroupCommand.ts @@ -73,6 +73,9 @@ export interface CreateGroupCommandOutput extends CreateGroupOutput, __MetadataB * ], * }, * ], + * Criticality: Number("int"), + * Owner: "STRING_VALUE", + * DisplayName: "STRING_VALUE", * }; * const command = new CreateGroupCommand(input); * const response = await client.send(command); @@ -81,6 +84,12 @@ export interface CreateGroupCommandOutput extends CreateGroupOutput, __MetadataB * // GroupArn: "STRING_VALUE", // required * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", + * // Criticality: Number("int"), + * // Owner: "STRING_VALUE", + * // DisplayName: "STRING_VALUE", + * // ApplicationTag: { // ApplicationTag + * // "Returns information about a specified tag-sync task.
+ *+ * Minimum permissions + *
+ *To run this command, you must have the following permissions:
+ *
+ * resource-groups:GetTagSyncTask on the application group
The request includes one or more parameters that violate validation rules.
+ * + * @throws {@link ForbiddenException} (client fault) + *The caller isn't authorized to make the request. Check permissions.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *An internal error occurred while processing the request. Try again later.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *The request uses an HTTP method that isn't allowed for the specified resource.
+ * + * @throws {@link NotFoundException} (client fault) + *One or more of the specified resources don't exist.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *You've exceeded throttling limits by making too many requests in a period of + * time.
+ * + * @throws {@link UnauthorizedException} (client fault) + *The request was rejected because it doesn't have valid credentials for the target + * resource.
+ * + * @throws {@link ResourceGroupsServiceException} + *Base exception class for all service exceptions from ResourceGroups service.
+ * + * @public + */ +export class GetTagSyncTaskCommand extends $Command + .classBuilder< + GetTagSyncTaskCommandInput, + GetTagSyncTaskCommandOutput, + ResourceGroupsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceGroupsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Ardi", "GetTagSyncTask", {}) + .n("ResourceGroupsClient", "GetTagSyncTaskCommand") + .f(void 0, void 0) + .ser(se_GetTagSyncTaskCommand) + .de(de_GetTagSyncTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetTagSyncTaskInput; + output: GetTagSyncTaskOutput; + }; + sdk: { + input: GetTagSyncTaskCommandInput; + output: GetTagSyncTaskCommandOutput; + }; + }; +} diff --git a/clients/client-resource-groups/src/commands/GetTagsCommand.ts b/clients/client-resource-groups/src/commands/GetTagsCommand.ts index 9ff0a386b38d..dec4066cb32b 100644 --- a/clients/client-resource-groups/src/commands/GetTagsCommand.ts +++ b/clients/client-resource-groups/src/commands/GetTagsCommand.ts @@ -29,7 +29,7 @@ export interface GetTagsCommandOutput extends GetTagsOutput, __MetadataBearer {} /** *Returns a list of tags that are associated with a resource group, specified by an - * ARN.
+ * Amazon resource name (ARN). ** Minimum permissions *
diff --git a/clients/client-resource-groups/src/commands/GroupResourcesCommand.ts b/clients/client-resource-groups/src/commands/GroupResourcesCommand.ts index f0859a62e6da..9af739de0a67 100644 --- a/clients/client-resource-groups/src/commands/GroupResourcesCommand.ts +++ b/clients/client-resource-groups/src/commands/GroupResourcesCommand.ts @@ -30,8 +30,7 @@ export interface GroupResourcesCommandOutput extends GroupResourcesOutput, __Met /** *Adds the specified resources to the specified group.
*You can use this operation with only resource groups that are configured with the - * following types:
+ *You can only use this operation with the following groups:
*
@@ -43,8 +42,13 @@ export interface GroupResourcesCommandOutput extends GroupResourcesOutput, __Met
* AWS::EC2::CapacityReservationPool
*
+ * AWS::ResourceGroups::ApplicationGroup
+ *
Other resource group type and resource types aren't currently supported by this + *
Other resource group types and resource types are not currently supported by this * operation.
*diff --git a/clients/client-resource-groups/src/commands/ListGroupResourcesCommand.ts b/clients/client-resource-groups/src/commands/ListGroupResourcesCommand.ts index e814e0faa8f1..f1b6f162c97b 100644 --- a/clients/client-resource-groups/src/commands/ListGroupResourcesCommand.ts +++ b/clients/client-resource-groups/src/commands/ListGroupResourcesCommand.ts @@ -28,7 +28,7 @@ export interface ListGroupResourcesCommandInput extends ListGroupResourcesInput export interface ListGroupResourcesCommandOutput extends ListGroupResourcesOutput, __MetadataBearer {} /** - *
Returns a list of ARNs of the resources that are members of a specified resource + *
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource * group.
** Minimum permissions diff --git a/clients/client-resource-groups/src/commands/ListGroupingStatusesCommand.ts b/clients/client-resource-groups/src/commands/ListGroupingStatusesCommand.ts new file mode 100644 index 000000000000..4d01a8a979b1 --- /dev/null +++ b/clients/client-resource-groups/src/commands/ListGroupingStatusesCommand.ts @@ -0,0 +1,130 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListGroupingStatusesInput, ListGroupingStatusesOutput } from "../models/models_0"; +import { de_ListGroupingStatusesCommand, se_ListGroupingStatusesCommand } from "../protocols/Aws_restJson1"; +import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListGroupingStatusesCommand}. + */ +export interface ListGroupingStatusesCommandInput extends ListGroupingStatusesInput {} +/** + * @public + * + * The output of {@link ListGroupingStatusesCommand}. + */ +export interface ListGroupingStatusesCommandOutput extends ListGroupingStatusesOutput, __MetadataBearer {} + +/** + *
Returns the status of the last grouping or ungrouping action for + * each resource in the specified application group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, ListGroupingStatusesCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, ListGroupingStatusesCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const input = { // ListGroupingStatusesInput + * Group: "STRING_VALUE", // required + * MaxResults: Number("int"), + * Filters: [ // ListGroupingStatusesFilterList + * { // ListGroupingStatusesFilter + * Name: "status" || "resource-arn", // required + * Values: [ // ListGroupingStatusesFilterValues // required + * "STRING_VALUE", + * ], + * }, + * ], + * NextToken: "STRING_VALUE", + * }; + * const command = new ListGroupingStatusesCommand(input); + * const response = await client.send(command); + * // { // ListGroupingStatusesOutput + * // Group: "STRING_VALUE", + * // GroupingStatuses: [ // GroupingStatusesList + * // { // GroupingStatusesItem + * // ResourceArn: "STRING_VALUE", + * // Action: "GROUP" || "UNGROUP", + * // Status: "SUCCESS" || "FAILED" || "IN_PROGRESS" || "SKIPPED", + * // ErrorMessage: "STRING_VALUE", + * // ErrorCode: "STRING_VALUE", + * // UpdatedAt: new Date("TIMESTAMP"), + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListGroupingStatusesCommandInput - {@link ListGroupingStatusesCommandInput} + * @returns {@link ListGroupingStatusesCommandOutput} + * @see {@link ListGroupingStatusesCommandInput} for command's `input` shape. + * @see {@link ListGroupingStatusesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for ResourceGroupsClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *The request includes one or more parameters that violate validation rules.
+ * + * @throws {@link ForbiddenException} (client fault) + *The caller isn't authorized to make the request. Check permissions.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *An internal error occurred while processing the request. Try again later.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *The request uses an HTTP method that isn't allowed for the specified resource.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *You've exceeded throttling limits by making too many requests in a period of + * time.
+ * + * @throws {@link ResourceGroupsServiceException} + *Base exception class for all service exceptions from ResourceGroups service.
+ * + * @public + */ +export class ListGroupingStatusesCommand extends $Command + .classBuilder< + ListGroupingStatusesCommandInput, + ListGroupingStatusesCommandOutput, + ResourceGroupsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceGroupsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Ardi", "ListGroupingStatuses", {}) + .n("ResourceGroupsClient", "ListGroupingStatusesCommand") + .f(void 0, void 0) + .ser(se_ListGroupingStatusesCommand) + .de(de_ListGroupingStatusesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListGroupingStatusesInput; + output: ListGroupingStatusesOutput; + }; + sdk: { + input: ListGroupingStatusesCommandInput; + output: ListGroupingStatusesCommandOutput; + }; + }; +} diff --git a/clients/client-resource-groups/src/commands/ListGroupsCommand.ts b/clients/client-resource-groups/src/commands/ListGroupsCommand.ts index 47b92f4535d1..40fcdb299d85 100644 --- a/clients/client-resource-groups/src/commands/ListGroupsCommand.ts +++ b/clients/client-resource-groups/src/commands/ListGroupsCommand.ts @@ -49,7 +49,7 @@ export interface ListGroupsCommandOutput extends ListGroupsOutput, __MetadataBea * const input = { // ListGroupsInput * Filters: [ // GroupFilterList * { // GroupFilter - * Name: "resource-type" || "configuration-type", // required + * Name: "resource-type" || "configuration-type" || "owner" || "display-name" || "criticality", // required * Values: [ // GroupFilterValues // required * "STRING_VALUE", * ], @@ -65,6 +65,10 @@ export interface ListGroupsCommandOutput extends ListGroupsOutput, __MetadataBea * // { // GroupIdentifier * // GroupName: "STRING_VALUE", * // GroupArn: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // Criticality: Number("int"), + * // Owner: "STRING_VALUE", + * // DisplayName: "STRING_VALUE", * // }, * // ], * // Groups: [ // GroupList @@ -72,6 +76,12 @@ export interface ListGroupsCommandOutput extends ListGroupsOutput, __MetadataBea * // GroupArn: "STRING_VALUE", // required * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", + * // Criticality: Number("int"), + * // Owner: "STRING_VALUE", + * // DisplayName: "STRING_VALUE", + * // ApplicationTag: { // ApplicationTag + * // "Returns a list of tag-sync tasks.
+ *+ * Minimum permissions + *
+ *To run this command, you must have the following permissions:
+ *
+ * resource-groups:ListTagSyncTasks with the group passed in the filters as the resource
+ * or * if using no filters
The request includes one or more parameters that violate validation rules.
+ * + * @throws {@link ForbiddenException} (client fault) + *The caller isn't authorized to make the request. Check permissions.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *An internal error occurred while processing the request. Try again later.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *The request uses an HTTP method that isn't allowed for the specified resource.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *You've exceeded throttling limits by making too many requests in a period of + * time.
+ * + * @throws {@link UnauthorizedException} (client fault) + *The request was rejected because it doesn't have valid credentials for the target + * resource.
+ * + * @throws {@link ResourceGroupsServiceException} + *Base exception class for all service exceptions from ResourceGroups service.
+ * + * @public + */ +export class ListTagSyncTasksCommand extends $Command + .classBuilder< + ListTagSyncTasksCommandInput, + ListTagSyncTasksCommandOutput, + ResourceGroupsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceGroupsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Ardi", "ListTagSyncTasks", {}) + .n("ResourceGroupsClient", "ListTagSyncTasksCommand") + .f(void 0, void 0) + .ser(se_ListTagSyncTasksCommand) + .de(de_ListTagSyncTasksCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTagSyncTasksInput; + output: ListTagSyncTasksOutput; + }; + sdk: { + input: ListTagSyncTasksCommandInput; + output: ListTagSyncTasksCommandOutput; + }; + }; +} diff --git a/clients/client-resource-groups/src/commands/StartTagSyncTaskCommand.ts b/clients/client-resource-groups/src/commands/StartTagSyncTaskCommand.ts new file mode 100644 index 000000000000..96be541b36f6 --- /dev/null +++ b/clients/client-resource-groups/src/commands/StartTagSyncTaskCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartTagSyncTaskInput, StartTagSyncTaskOutput } from "../models/models_0"; +import { de_StartTagSyncTaskCommand, se_StartTagSyncTaskCommand } from "../protocols/Aws_restJson1"; +import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartTagSyncTaskCommand}. + */ +export interface StartTagSyncTaskCommandInput extends StartTagSyncTaskInput {} +/** + * @public + * + * The output of {@link StartTagSyncTaskCommand}. + */ +export interface StartTagSyncTaskCommandOutput extends StartTagSyncTaskOutput, __MetadataBearer {} + +/** + *Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an + * application.
+ *+ * Minimum permissions + *
+ *To run this command, you must have the following permissions:
+ *
+ * resource-groups:StartTagSyncTask on the application group
+ * resource-groups:CreateGroup
+ *
+ * iam:PassRole on the role provided in the request
The request includes one or more parameters that violate validation rules.
+ * + * @throws {@link ForbiddenException} (client fault) + *The caller isn't authorized to make the request. Check permissions.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *An internal error occurred while processing the request. Try again later.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *The request uses an HTTP method that isn't allowed for the specified resource.
+ * + * @throws {@link NotFoundException} (client fault) + *One or more of the specified resources don't exist.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *You've exceeded throttling limits by making too many requests in a period of + * time.
+ * + * @throws {@link UnauthorizedException} (client fault) + *The request was rejected because it doesn't have valid credentials for the target + * resource.
+ * + * @throws {@link ResourceGroupsServiceException} + *Base exception class for all service exceptions from ResourceGroups service.
+ * + * @public + */ +export class StartTagSyncTaskCommand extends $Command + .classBuilder< + StartTagSyncTaskCommandInput, + StartTagSyncTaskCommandOutput, + ResourceGroupsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceGroupsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Ardi", "StartTagSyncTask", {}) + .n("ResourceGroupsClient", "StartTagSyncTaskCommand") + .f(void 0, void 0) + .ser(se_StartTagSyncTaskCommand) + .de(de_StartTagSyncTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartTagSyncTaskInput; + output: StartTagSyncTaskOutput; + }; + sdk: { + input: StartTagSyncTaskCommandInput; + output: StartTagSyncTaskCommandOutput; + }; + }; +} diff --git a/clients/client-resource-groups/src/commands/TagCommand.ts b/clients/client-resource-groups/src/commands/TagCommand.ts index d915c5918939..8f3a83ba05f3 100644 --- a/clients/client-resource-groups/src/commands/TagCommand.ts +++ b/clients/client-resource-groups/src/commands/TagCommand.ts @@ -28,7 +28,7 @@ export interface TagCommandInput extends TagInput {} export interface TagCommandOutput extends TagOutput, __MetadataBearer {} /** - *Adds tags to a resource group with the specified ARN. Existing tags on a resource + *
Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource * group are not changed if they are not specified in the request parameters.
*Do not store personally identifiable information (PII) or other confidential or
diff --git a/clients/client-resource-groups/src/commands/UpdateGroupCommand.ts b/clients/client-resource-groups/src/commands/UpdateGroupCommand.ts
index 5791e72ae342..cb020b24b09f 100644
--- a/clients/client-resource-groups/src/commands/UpdateGroupCommand.ts
+++ b/clients/client-resource-groups/src/commands/UpdateGroupCommand.ts
@@ -51,6 +51,9 @@ export interface UpdateGroupCommandOutput extends UpdateGroupOutput, __MetadataB
* GroupName: "STRING_VALUE",
* Group: "STRING_VALUE",
* Description: "STRING_VALUE",
+ * Criticality: Number("int"),
+ * Owner: "STRING_VALUE",
+ * DisplayName: "STRING_VALUE",
* };
* const command = new UpdateGroupCommand(input);
* const response = await client.send(command);
@@ -59,6 +62,12 @@ export interface UpdateGroupCommandOutput extends UpdateGroupOutput, __MetadataB
* // GroupArn: "STRING_VALUE", // required
* // Name: "STRING_VALUE", // required
* // Description: "STRING_VALUE",
+ * // Criticality: Number("int"),
+ * // Owner: "STRING_VALUE",
+ * // DisplayName: "STRING_VALUE",
+ * // ApplicationTag: { // ApplicationTag
+ * // " Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search + *
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search * results
*The Amazon resource name (ARN) of the tag-sync task.
+ * @public + */ + TaskArn: string | undefined; +} + +/** + *The caller isn't authorized to make the request. Check permissions.
+ * @public + */ +export class ForbiddenException extends __BaseException { + readonly name: "ForbiddenException" = "ForbiddenException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn internal error occurred while processing the request. Try again later.
+ * @public + */ +export class InternalServerErrorException extends __BaseException { + readonly name: "InternalServerErrorException" = "InternalServerErrorException"; + readonly $fault: "server" = "server"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request uses an HTTP method that isn't allowed for the specified resource.
+ * @public + */ +export class MethodNotAllowedException extends __BaseException { + readonly name: "MethodNotAllowedException" = "MethodNotAllowedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYou've exceeded throttling limits by making too many requests in a period of + * time.
+ * @public + */ +export class TooManyRequestsException extends __BaseException { + readonly name: "TooManyRequestsException" = "TooManyRequestsException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was rejected because it doesn't have valid credentials for the target + * resource.
+ * @public + */ +export class UnauthorizedException extends __BaseException { + readonly name: "UnauthorizedException" = "UnauthorizedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA parameter for a group configuration item. For details about group service
* configuration syntax, see Service configurations for resource
@@ -183,7 +306,7 @@ export interface ResourceQuery {
* CLOUDFORMATION_STACK_1_0:
* Specifies that you
* want the group to contain the members of an CloudFormation stack. The Query
- * contains a StackIdentifier element with an ARN for a CloudFormation
+ * contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation
* stack.
The critical rank of the application group on a scale of 1 to 10, with a + * rank of 1 being the most critical, and a rank of 10 being least critical.
+ * @public + */ + Criticality?: number; + + /** + *A name, email address or other identifier for the person or group + * who is considered as the owner of this application group within your organization.
+ * @public + */ + Owner?: string; + + /** + *The name of the application group, which you can change at any time.
+ * @public + */ + DisplayName?: string; } /** @@ -375,7 +518,7 @@ export interface CreateGroupInput { */ export interface Group { /** - *The ARN of the resource group.
+ *The Amazon resource name (ARN) of the resource group.
* @public */ GroupArn: string | undefined; @@ -391,6 +534,33 @@ export interface Group { * @public */ Description?: string; + + /** + *The critical rank of the application group on a scale of 1 to 10, with a + * rank of 1 being the most critical, and a rank of 10 being least critical.
+ * @public + */ + Criticality?: number; + + /** + *A name, email address or other identifier for the person or group + * who is considered as the owner of this application group within your organization.
+ * @public + */ + Owner?: string; + + /** + *The name of the application group, which you can change at any time.
+ * @public + */ + DisplayName?: string; + + /** + *A tag that defines the application group membership. This tag is only supported + * for application groups.
+ * @public + */ + ApplicationTag?: RecordThe caller isn't authorized to make the request. Check permissions.
- * @public - */ -export class ForbiddenException extends __BaseException { - readonly name: "ForbiddenException" = "ForbiddenException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeAn internal error occurred while processing the request. Try again later.
- * @public - */ -export class InternalServerErrorException extends __BaseException { - readonly name: "InternalServerErrorException" = "InternalServerErrorException"; - readonly $fault: "server" = "server"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe request uses an HTTP method that isn't allowed for the specified resource.
- * @public - */ -export class MethodNotAllowedException extends __BaseException { - readonly name: "MethodNotAllowedException" = "MethodNotAllowedException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeYou've exceeded throttling limits by making too many requests in a period of - * time.
- * @public - */ -export class TooManyRequestsException extends __BaseException { - readonly name: "TooManyRequestsException" = "TooManyRequestsException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe name or the ARN of the resource group to delete.
+ *The name or the Amazon resource name (ARN) of the resource group to delete.
* @public */ Group?: string; @@ -641,7 +722,7 @@ export interface GetGroupInput { GroupName?: string; /** - *The name or the ARN of the resource group to retrieve.
+ *The name or the Amazon resource name (ARN) of the resource group to retrieve.
* @public */ Group?: string; @@ -665,7 +746,7 @@ export interface GetGroupOutput { */ export interface GetGroupConfigurationInput { /** - *The name or the ARN of the resource group for which you want to retrive the service + *
The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service * configuration.
* @public */ @@ -698,7 +779,7 @@ export interface GetGroupQueryInput { GroupName?: string; /** - *The name or the ARN of the resource group to query.
+ *The name or the Amazon resource name (ARN) of the resource group to query.
* @public */ Group?: string; @@ -743,7 +824,7 @@ export interface GetGroupQueryOutput { */ export interface GetTagsInput { /** - *The ARN of the resource group whose tags you want to retrieve.
+ *The Amazon resource name (ARN) of the resource group whose tags you want to retrieve.
* @public */ Arn: string | undefined; @@ -752,103 +833,376 @@ export interface GetTagsInput { /** * @public */ -export interface GetTagsOutput { - /** - *The ARN of the tagged resource group.
- * @public - */ - Arn?: string; - - /** - *The tags associated with the specified resource group.
- * @public - */ - Tags?: RecordTheAmazon resource name (ARN) of the tagged resource group.
+ * @public + */ + Arn?: string; + + /** + *The tags associated with the specified resource group.
+ * @public + */ + Tags?: RecordThe Amazon resource name (ARN) of the tag-sync task.
+ * @public + */ + TaskArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const TagSyncTaskStatus = { + ACTIVE: "ACTIVE", + ERROR: "ERROR", +} as const; + +/** + * @public + */ +export type TagSyncTaskStatus = (typeof TagSyncTaskStatus)[keyof typeof TagSyncTaskStatus]; + +/** + * @public + */ +export interface GetTagSyncTaskOutput { + /** + *The Amazon resource name (ARN) of the application group.
+ * @public + */ + GroupArn?: string; + + /** + *The name of the application group.
+ * @public + */ + GroupName?: string; + + /** + *The Amazon resource name (ARN) of the tag-sync task.
+ * @public + */ + TaskArn?: string; + + /** + *The tag key.
+ * @public + */ + TagKey?: string; + + /** + *The tag value.
+ * @public + */ + TagValue?: string; + + /** + *The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf.
+ *For more information about this role, review Tag-sync required permissions. + *
+ * @public + */ + RoleArn?: string; + + /** + *The status of the tag-sync task.
+ *Valid values include:
+ *
+ * ACTIVE - The tag-sync task is actively managing resources in
+ * the application by adding or removing the awsApplication tag from resources
+ * when they are tagged or untagged with the specified tag key-value pair.
+ *
+ * ERROR - The tag-sync task is not actively managing resources
+ * in the application. Review the ErrorMessage for more information about
+ * resolving the error.
+ *
The specific error message in cases where the tag-sync task status
+ * is ERROR.
The timestamp of when the tag-sync task was created.
+ * @public + */ + CreatedAt?: Date; +} + +/** + * @public + */ +export interface GroupResourcesInput { + /** + *The name or the Amazon resource name (ARN) of the resource group to add resources to.
+ * @public + */ + Group: string | undefined; + + /** + *The list of Amazon resource names (ARNs) of the resources to be added to the group.
+ * @public + */ + ResourceArns: string[] | undefined; +} + +/** + *A resource that failed to be added to or removed from a group.
+ * @public + */ +export interface FailedResource { + /** + *The Amazon resource name (ARN) of the resource that failed to be added or removed.
+ * @public + */ + ResourceArn?: string; + + /** + *The error message text associated with the failure.
+ * @public + */ + ErrorMessage?: string; + + /** + *The error code associated with the failure.
+ * @public + */ + ErrorCode?: string; +} + +/** + *A structure that identifies a resource that is currently pending addition to the group + * as a member. Adding a resource to a resource group happens asynchronously as a + * background task and this one isn't completed yet.
+ * @public + */ +export interface PendingResource { + /** + *The Amazon resource name (ARN) of the resource that's in a pending state.
+ * @public + */ + ResourceArn?: string; +} + +/** + * @public + */ +export interface GroupResourcesOutput { + /** + *A list of Amazon resource names (ARNs) of the resources that this operation successfully added to the + * group.
+ * @public + */ + Succeeded?: string[]; + + /** + *A list of Amazon resource names (ARNs) of any resources that this operation failed to add to the group.
+ * @public + */ + Failed?: FailedResource[]; + + /** + *A list of Amazon resource names (ARNs) of any resources that this operation is still in the process adding to
+ * the group. These pending additions continue asynchronously. You can check the status of
+ * pending additions by using the
+ * ListGroupResources
+ *
+ * operation, and checking the Resources array in the response and the
+ * Status field of each object in that array.
A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.
+ * @public + */ +export interface ListGroupingStatusesFilter { + /** + *The name of the filter. Filter names are case-sensitive.
+ * @public + */ + Name: ListGroupingStatusesFilterName | undefined; + + /** + *One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
+ * @public + */ + Values: string[] | undefined; +} + +/** + * @public + */ +export interface ListGroupingStatusesInput { + /** + *The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
+ * @public + */ + Group: string | undefined; + + /** + *The maximum number of resources and their statuses returned in the + * response.
+ * @public + */ + MaxResults?: number; + + /** + *The filter name and value pair that is used to return more + * specific results from a list of resources.
+ * @public + */ + Filters?: ListGroupingStatusesFilter[]; + + /** + *The parameter for receiving additional results if you receive a
+ * NextToken response in a previous request. A NextToken
+ * response indicates that more output is available. Set this parameter to the
+ * value provided by a previous call's NextToken response to indicate
+ * where the output should continue from.
The information about a grouping or ungrouping resource action.
* @public */ -export interface GroupResourcesInput { +export interface GroupingStatusesItem { /** - *The name or the ARN of the resource group to add resources to.
+ *The Amazon resource name (ARN) of a resource.
* @public */ - Group: string | undefined; + ResourceArn?: string; /** - *The list of ARNs of the resources to be added to the group.
+ *Describes the resource grouping action with values of
+ * GROUP or UNGROUP.
A resource that failed to be added to or removed from a group.
- * @public - */ -export interface FailedResource { /** - *The ARN of the resource that failed to be added or removed.
+ *Describes the resource grouping status with values of
+ * SUCCESS, FAILED, IN_PROGRESS,
+ * or SKIPPED.
The error message text associated with the failure.
+ *A message that explains the ErrorCode.
The error code associated with the failure.
+ *Specifies the error code that was raised.
* @public */ ErrorCode?: string; -} -/** - *A structure that identifies a resource that is currently pending addition to the group - * as a member. Adding a resource to a resource group happens asynchronously as a - * background task and this one isn't completed yet.
- * @public - */ -export interface PendingResource { /** - *The Amazon resource name (ARN) of the resource that's in a pending state.
+ *A timestamp of when the status was last updated.
* @public */ - ResourceArn?: string; + UpdatedAt?: Date; } /** * @public */ -export interface GroupResourcesOutput { +export interface ListGroupingStatusesOutput { /** - *A list of ARNs of the resources that this operation successfully added to the - * group.
+ *The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
* @public */ - Succeeded?: string[]; + Group?: string; /** - *A list of ARNs of any resources that this operation failed to add to the group.
+ *Returns details about the grouping or ungrouping status of the + * resources in the specified application group.
* @public */ - Failed?: FailedResource[]; + GroupingStatuses?: GroupingStatusesItem[]; /** - *A list of ARNs of any resources that this operation is still in the process adding to
- * the group. These pending additions continue asynchronously. You can check the status of
- * pending additions by using the
- * ListGroupResources
- *
- * operation, and checking the Resources array in the response and the
- * Status field of each object in that array.
If present, indicates that more output is available than is included in the current response.
+ * Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output.
+ * You should repeat this until the NextToken response element comes back as null.
The name or the ARN of the resource group
+ *The name or the Amazon resource name (ARN) of the resource group.
* @public */ Group?: string; @@ -1007,7 +1361,7 @@ export interface QueryError { */ export interface ResourceIdentifier { /** - *The ARN of a resource.
+ *The Amazon resource name (ARN) of a resource.
* @public */ ResourceArn?: string; @@ -1118,35 +1472,15 @@ export interface ListGroupResourcesOutput { QueryErrors?: QueryError[]; } -/** - *The request was rejected because it doesn't have valid credentials for the target - * resource.
- * @public - */ -export class UnauthorizedException extends __BaseException { - readonly name: "UnauthorizedException" = "UnauthorizedException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType
+ * AWS::ResourceGroups::ApplicationGroup
+ *
* AWS::AppRegistry::Application
*
The ARN of the resource group.
+ *The Amazon resource name (ARN) of the resource group.
* @public */ GroupArn?: string; + + /** + *The description of the application group.
+ * @public + */ + Description?: string; + + /** + *The critical rank of the application group on a scale of 1 to 10, with a + * rank of 1 being the most critical, and a rank of 10 being least critical.
+ * @public + */ + Criticality?: number; + + /** + *A name, email address or other identifier for the person or group + * who is considered as the owner of this group within your organization.
+ * @public + */ + Owner?: string; + + /** + *The name of the application group, which you can change at any time.
+ * @public + */ + DisplayName?: string; } /** @@ -1311,12 +1676,156 @@ export interface ListGroupsOutput { NextToken?: string; } +/** + *Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a + * specified application group.
+ * @public + */ +export interface ListTagSyncTasksFilter { + /** + *The Amazon resource name (ARN) of the application group.
+ * @public + */ + GroupArn?: string; + + /** + *The name of the application group.
+ * @public + */ + GroupName?: string; +} + +/** + * @public + */ +export interface ListTagSyncTasksInput { + /** + *The Amazon resource name (ARN) or name of the application group for which you want to return a + * list of tag-sync tasks.
+ * @public + */ + Filters?: ListTagSyncTasksFilter[]; + + /** + *The maximum number of results to be included in the response.
+ * @public + */ + MaxResults?: number; + + /** + *The parameter for receiving additional results if you receive a
+ * NextToken response in a previous request. A NextToken
+ * response indicates that more output is available. Set this parameter to the
+ * value provided by a previous call's NextToken response to indicate
+ * where the output should continue from.
The Amazon resource name (ARN) of the tag-sync task.
+ * @public + */ +export interface TagSyncTaskItem { + /** + *The Amazon resource name (ARN) of the application group.
+ * @public + */ + GroupArn?: string; + + /** + *The name of the application group.
+ * @public + */ + GroupName?: string; + + /** + *The Amazon resource name (ARN) of the tag-sync task.
+ * @public + */ + TaskArn?: string; + + /** + *The tag key.
+ * @public + */ + TagKey?: string; + + /** + *The tag value.
+ * @public + */ + TagValue?: string; + + /** + *The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+ * @public + */ + RoleArn?: string; + + /** + *The status of the tag-sync task.
+ *Valid values include:
+ *
+ * ACTIVE - The tag-sync task is actively managing resources in
+ * the application by adding or removing the awsApplication tag from resources
+ * when they are tagged or untagged with the specified tag key-value pair.
+ *
+ * ERROR - The tag-sync task is not actively managing resources
+ * in the application. Review the ErrorMessage for more information about
+ * resolving the error.
+ *
The specific error message in cases where the tag-sync task status
+ * is Error.
The timestamp of when the tag-sync task was created.
+ * @public + */ + CreatedAt?: Date; +} + +/** + * @public + */ +export interface ListTagSyncTasksOutput { + /** + *A list of tag-sync tasks and information about each task.
+ * @public + */ + TagSyncTasks?: TagSyncTaskItem[]; + + /** + *If present, indicates that more output is available than is included in the current response.
+ * Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output.
+ * You should repeat this until the NextToken response element comes back as null.
The name or ARN of the resource group with the configuration that you want to + *
The name or Amazon resource name (ARN) of the resource group with the configuration that you want to * update.
* @public */ @@ -1422,12 +1931,86 @@ export interface SearchResourcesOutput { QueryErrors?: QueryError[]; } +/** + * @public + */ +export interface StartTagSyncTaskInput { + /** + *The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
+ * @public + */ + Group: string | undefined; + + /** + *The tag key. Resources tagged with this tag key-value pair will be added to + * the application. If a resource with this tag is later untagged, the tag-sync task removes + * the resource from the application.
+ * @public + */ + TagKey: string | undefined; + + /** + *The tag value. Resources tagged with this tag key-value pair will be added to + * the application. If a resource with this tag is later untagged, the tag-sync task removes + * the resource from the application.
+ * @public + */ + TagValue: string | undefined; + + /** + *The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+ * @public + */ + RoleArn: string | undefined; +} + +/** + * @public + */ +export interface StartTagSyncTaskOutput { + /** + *The Amazon resource name (ARN) of the application group for which you want to add or remove resources.
+ * @public + */ + GroupArn?: string; + + /** + *The name of the application group to onboard and sync resources.
+ * @public + */ + GroupName?: string; + + /** + *The Amazon resource name (ARN) of the new tag-sync task.
+ * @public + */ + TaskArn?: string; + + /** + *The tag key of the tag-sync task.
+ * @public + */ + TagKey?: string; + + /** + *The tag value of the tag-sync task.
+ * @public + */ + TagValue?: string; + + /** + *The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+ * @public + */ + RoleArn?: string; +} + /** * @public */ export interface TagInput { /** - *The ARN of the resource group to which to add tags.
+ *The Amazon resource name (ARN) of the resource group to which to add tags.
* @public */ Arn: string | undefined; @@ -1445,7 +2028,7 @@ export interface TagInput { */ export interface TagOutput { /** - *The ARN of the tagged resource.
+ *The Amazon resource name (ARN) of the tagged resource.
* @public */ Arn?: string; @@ -1462,13 +2045,13 @@ export interface TagOutput { */ export interface UngroupResourcesInput { /** - *The name or the ARN of the resource group from which to remove the resources.
+ *The name or the Amazon resource name (ARN) of the resource group from which to remove the resources.
* @public */ Group: string | undefined; /** - *The ARNs of the resources to be removed from the group.
+ *The Amazon resource names (ARNs) of the resources to be removed from the group.
* @public */ ResourceArns: string[] | undefined; @@ -1509,7 +2092,7 @@ export interface UngroupResourcesOutput { */ export interface UntagInput { /** - *The ARN of the resource group from which to remove tags. The command removed both the + *
The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the * specified keys and any values associated with those keys.
* @public */ @@ -1527,7 +2110,7 @@ export interface UntagInput { */ export interface UntagOutput { /** - *The ARN of the resource group from which tags have been removed.
+ *The Amazon resource name (ARN) of the resource group from which tags have been removed.
* @public */ Arn?: string; @@ -1545,6 +2128,7 @@ export interface UntagOutput { export interface UpdateAccountSettingsInput { /** *Specifies whether you want to turn group lifecycle events on or off.
+ *You can't turn on group lifecycle events if your resource groups quota is greater than 2,000.
* @public */ GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus; @@ -1574,7 +2158,7 @@ export interface UpdateGroupInput { GroupName?: string; /** - *The name or the ARN of the resource group to modify.
+ *The name or the ARN of the resource group to update.
* @public */ Group?: string; @@ -1585,6 +2169,26 @@ export interface UpdateGroupInput { * @public */ Description?: string; + + /** + *The critical rank of the application group on a scale of 1 to 10, with a + * rank of 1 being the most critical, and a rank of 10 being least critical.
+ * @public + */ + Criticality?: number; + + /** + *A name, email address or other identifier for the person or group + * who is considered as the owner of this application group within your organization.
+ * @public + */ + Owner?: string; + + /** + *The name of the application group, which you can change at any time.
+ * @public + */ + DisplayName?: string; } /** @@ -1611,7 +2215,7 @@ export interface UpdateGroupQueryInput { GroupName?: string; /** - *The name or the ARN of the resource group to query.
+ *The name or the Amazon resource name (ARN) of the resource group to query.
* @public */ Group?: string; diff --git a/clients/client-resource-groups/src/pagination/ListGroupingStatusesPaginator.ts b/clients/client-resource-groups/src/pagination/ListGroupingStatusesPaginator.ts new file mode 100644 index 000000000000..0bbc288df7fa --- /dev/null +++ b/clients/client-resource-groups/src/pagination/ListGroupingStatusesPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListGroupingStatusesCommand, + ListGroupingStatusesCommandInput, + ListGroupingStatusesCommandOutput, +} from "../commands/ListGroupingStatusesCommand"; +import { ResourceGroupsClient } from "../ResourceGroupsClient"; +import { ResourceGroupsPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListGroupingStatuses: ( + config: ResourceGroupsPaginationConfiguration, + input: ListGroupingStatusesCommandInput, + ...rest: any[] +) => PaginatorThe Resource Groups settings for this Amazon Web Services account.
" } }, + "com.amazonaws.resourcegroups#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-zA-Z0-9]{22,26}$" + } + }, + "com.amazonaws.resourcegroups#ApplicationTag": { + "type": "map", + "key": { + "target": "com.amazonaws.resourcegroups#ApplicationTagKey" + }, + "value": { + "target": "com.amazonaws.resourcegroups#ApplicationArn" + } + }, + "com.amazonaws.resourcegroups#ApplicationTagKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^awsApplication$" + } + }, "com.amazonaws.resourcegroups#Ardi": { "type": "service", "version": "2017-11-27", "operations": [ + { + "target": "com.amazonaws.resourcegroups#CancelTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#CreateGroup" }, @@ -80,21 +108,33 @@ { "target": "com.amazonaws.resourcegroups#GetTags" }, + { + "target": "com.amazonaws.resourcegroups#GetTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#GroupResources" }, + { + "target": "com.amazonaws.resourcegroups#ListGroupingStatuses" + }, { "target": "com.amazonaws.resourcegroups#ListGroupResources" }, { "target": "com.amazonaws.resourcegroups#ListGroups" }, + { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasks" + }, { "target": "com.amazonaws.resourcegroups#PutGroupConfiguration" }, { "target": "com.amazonaws.resourcegroups#SearchResources" }, + { + "target": "com.amazonaws.resourcegroups#StartTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#Tag" }, @@ -126,7 +166,7 @@ "name": "resource-groups" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service\n databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A\n resource group is a collection of resources that match the resource types specified in a\n query, and share one or more tags or portions of tags. You can create a group of\n resources based on their roles in your cloud infrastructure, lifecycle stages, regions,\n application layers, or virtually any criteria. Resource Groups enable you to automate management\n tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in\n Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in\n Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member\n resources.
\nTo create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.
\nFor more information about Resource Groups, see the Resource Groups User Guide.
\nResource Groups uses a REST-compliant API that you can use to perform the following types of\n operations.
\nCreate, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities
\nApplying, editing, and removing tags from resource groups
\nResolving resource group member ARNs so they can be returned as search\n results
\nGetting data about resources that are members of a group
\nSearching Amazon Web Services resources based on a resource query
\nResource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service\n databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A\n resource group is a collection of resources that match the resource types specified in a\n query, and share one or more tags or portions of tags. You can create a group of\n resources based on their roles in your cloud infrastructure, lifecycle stages, regions,\n application layers, or virtually any criteria. Resource Groups enable you to automate management\n tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in\n Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in\n Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member\n resources.
\nTo create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.
\nFor more information about Resource Groups, see the Resource Groups User Guide.
\nResource Groups uses a REST-compliant API that you can use to perform the following types of\n operations.
\nCreate, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities
\nApplying, editing, and removing tags from resource groups
\nResolving resource group member Amazon resource names (ARN)s so they can be returned as search\n results
\nGetting data about resources that are members of a group
\nSearching Amazon Web Services resources based on a resource query
\nCancels the specified tag-sync task.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:CancelTagSyncTask on the application group
\n resource-groups:DeleteGroup\n
The Amazon resource name (ARN) of the tag-sync task.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.resourcegroups#CreateGroup": { "type": "operation", "input": { @@ -1185,7 +1277,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.resourcegroups#GroupName", + "target": "com.amazonaws.resourcegroups#CreateGroupName", "traits": { "smithy.api#documentation": "The name of the group, which is the identifier of the group in other operations. You\n can't change the name of a resource group after you create it. A resource group name can\n consist of letters, numbers, hyphens, periods, and underscores. The name cannot start\n with AWS, aws, or any other possible capitalization; these are\n reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services\n account.
A configuration associates the resource group with an Amazon Web Services service and specifies how\n the service can interact with the resources in the group. A configuration is an array of\n GroupConfigurationItem elements. For details about the syntax of\n service configurations, see Service configurations for Resource Groups.
\nA resource group can contain either a Configuration or a\n ResourceQuery, but not both.
The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.
" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the application group, which you can change at any time.
" + } } }, "traits": { "smithy.api#input": {} } }, + "com.amazonaws.resourcegroups#CreateGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]+$" + } + }, "com.amazonaws.resourcegroups#CreateGroupOutput": { "type": "structure", "members": { @@ -1252,6 +1372,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#Criticality": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.resourcegroups#DeleteGroup": { "type": "operation", "input": { @@ -1302,9 +1431,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group to delete.
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group to delete.
" } } }, @@ -1336,6 +1465,16 @@ "smithy.api#pattern": "^[\\sa-zA-Z0-9_\\.-]*$" } }, + "com.amazonaws.resourcegroups#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.resourcegroups#ErrorCode": { "type": "string", "traits": { @@ -1360,7 +1499,7 @@ "ResourceArn": { "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { - "smithy.api#documentation": "The ARN of the resource that failed to be added or removed.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource that failed to be added or removed.
" } }, "ErrorMessage": { @@ -1527,7 +1666,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group for which you want to retrive the service\n configuration.
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service\n configuration.
" } } }, @@ -1562,9 +1701,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group to retrieve.
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group to retrieve.
" } } }, @@ -1638,7 +1777,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group to query.
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group to query.
" } } }, @@ -1660,6 +1799,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#GetTagSyncTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#GetTagSyncTaskInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#GetTagSyncTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#NotFoundException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + }, + { + "target": "com.amazonaws.resourcegroups#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specified tag-sync task.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:GetTagSyncTask on the application group
The Amazon resource name (ARN) of the tag-sync task.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#GetTagSyncTaskOutput": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the application group.
" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "The name of the application group.
" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the tag-sync task.
" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "The tag key.
" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "The tag value.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf.
\nFor more information about this role, review Tag-sync required permissions. \n
" + } + }, + "Status": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskStatus", + "traits": { + "smithy.api#documentation": "The status of the tag-sync task.
\nValid values include:
\n\n ACTIVE - The tag-sync task is actively managing resources in \n the application by adding or removing the awsApplication tag from resources \n when they are tagged or untagged with the specified tag key-value pair. \n
\n ERROR - The tag-sync task is not actively managing resources \n in the application. Review the ErrorMessage for more information about \n resolving the error. \n
The specific error message in cases where the tag-sync task status\n is ERROR.
The timestamp of when the tag-sync task was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#GetTags": { "type": "operation", "input": { @@ -1689,7 +1945,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of tags that are associated with a resource group, specified by an\n ARN.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:GetTags\n
Returns a list of tags that are associated with a resource group, specified by an\n Amazon resource name (ARN).
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:GetTags\n
The ARN of the resource group whose tags you want to retrieve.
", + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group whose tags you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1717,9 +1973,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "The ARN of the tagged resource group.
" + "smithy.api#documentation": "TheAmazon resource name (ARN) of the tagged resource group.
" } }, "Tags": { @@ -1737,9 +1993,9 @@ "type": "structure", "members": { "GroupArn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "The ARN of the resource group.
", + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group.
", "smithy.api#required": {} } }, @@ -1755,6 +2011,30 @@ "traits": { "smithy.api#documentation": "The description of the resource group.
" } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.
" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the application group, which you can change at any time.
" + } + }, + "ApplicationTag": { + "target": "com.amazonaws.resourcegroups#ApplicationTag", + "traits": { + "smithy.api#documentation": "A tag that defines the application group membership. This tag is only supported \n for application groups.
" + } } }, "traits": { @@ -1768,7 +2048,17 @@ "min": 12, "max": 1600 }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,300}$" + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" + } + }, + "com.amazonaws.resourcegroups#GroupArnV2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" } }, "com.amazonaws.resourcegroups#GroupConfiguration": { @@ -1961,6 +2251,24 @@ "traits": { "smithy.api#enumValue": "configuration-type" } + }, + "Owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "owner" + } + }, + "DisplayName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "display-name" + } + }, + "Criticality": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "criticality" + } } } }, @@ -1969,9 +2277,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 300 }, - "smithy.api#pattern": "^AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+)$" + "smithy.api#pattern": "^AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+)|[\\s\\p{L}0-9_\\.-]*$" } }, "com.amazonaws.resourcegroups#GroupFilterValues": { @@ -1998,7 +2306,31 @@ "GroupArn": { "target": "com.amazonaws.resourcegroups#GroupArn", "traits": { - "smithy.api#documentation": "The ARN of the resource group.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group.
" + } + }, + "Description": { + "target": "com.amazonaws.resourcegroups#Description", + "traits": { + "smithy.api#documentation": "The description of the application group.
" + } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.
" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "A name, email address or other identifier for the person or group \n who is considered as the owner of this group within your organization.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the application group, which you can change at any time.
" } } }, @@ -2080,7 +2412,7 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]+$" + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}$" } }, "com.amazonaws.resourcegroups#GroupParameterList": { @@ -2140,7 +2472,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified resources to the specified group.
\nYou can use this operation with only resource groups that are configured with the\n following types:
\n\n AWS::EC2::HostManagement\n
\n AWS::EC2::CapacityReservationPool\n
Other resource group type and resource types aren't currently supported by this\n operation.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:GroupResources\n
Adds the specified resources to the specified group.
\nYou can only use this operation with the following groups:
\n\n AWS::EC2::HostManagement\n
\n AWS::EC2::CapacityReservationPool\n
\n AWS::ResourceGroups::ApplicationGroup\n
Other resource group types and resource types are not currently supported by this\n operation.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:GroupResources\n
The name or the ARN of the resource group to add resources to.
", + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group to add resources to.
", "smithy.api#required": {} } }, "ResourceArns": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "The list of ARNs of the resources to be added to the group.
", + "smithy.api#documentation": "The list of Amazon resource names (ARNs) of the resources to be added to the group.
", "smithy.api#required": {} } } @@ -2176,19 +2508,19 @@ "Succeeded": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "A list of ARNs of the resources that this operation successfully added to the\n group.
" + "smithy.api#documentation": "A list of Amazon resource names (ARNs) of the resources that this operation successfully added to the\n group.
" } }, "Failed": { "target": "com.amazonaws.resourcegroups#FailedResourceList", "traits": { - "smithy.api#documentation": "A list of ARNs of any resources that this operation failed to add to the group.
" + "smithy.api#documentation": "A list of Amazon resource names (ARNs) of any resources that this operation failed to add to the group.
" } }, "Pending": { "target": "com.amazonaws.resourcegroups#PendingResourceList", "traits": { - "smithy.api#documentation": "A list of ARNs of any resources that this operation is still in the process adding to\n the group. These pending additions continue asynchronously. You can check the status of\n pending additions by using the \n ListGroupResources\n \n operation, and checking the Resources array in the response and the\n Status field of each object in that array.
A list of Amazon resource names (ARNs) of any resources that this operation is still in the process adding to\n the group. These pending additions continue asynchronously. You can check the status of\n pending additions by using the \n ListGroupResources\n \n operation, and checking the Resources array in the response and the\n Status field of each object in that array.
The Amazon resource name (ARN) of a resource.
" + } + }, + "Action": { + "target": "com.amazonaws.resourcegroups#GroupingType", + "traits": { + "smithy.api#documentation": "Describes the resource grouping action with values of \n GROUP or UNGROUP.
Describes the resource grouping status with values of \n SUCCESS, FAILED, IN_PROGRESS, \n or SKIPPED.
A message that explains the ErrorCode.
Specifies the error code that was raised.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.resourcegroups#timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of when the status was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The information about a grouping or ungrouping resource action.
" + } + }, + "com.amazonaws.resourcegroups#GroupingStatusesList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#GroupingStatusesItem" + } + }, + "com.amazonaws.resourcegroups#GroupingType": { + "type": "enum", + "members": { + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "UNGROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNGROUP" + } + } + } + }, + "com.amazonaws.resourcegroups#InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.resourcegroups#ErrorMessage" + } + }, "traits": { "smithy.api#documentation": "An internal error occurred while processing the request. Try again later.
", "smithy.api#error": "server", @@ -2251,7 +2689,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of ARNs of the resources that are members of a specified resource\n group.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:ListGroupResources\n
\n cloudformation:DescribeStacks\n
\n cloudformation:ListStackResources\n
\n tag:GetResources\n
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource\n group.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:ListGroupResources\n
\n cloudformation:DescribeStacks\n
\n cloudformation:ListStackResources\n
\n tag:GetResources\n
The name or the ARN of the resource group
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group.
" } }, "Filters": { @@ -2364,6 +2802,168 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#ListGroupingStatuses": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the status of the last grouping or ungrouping action for \n each resource in the specified application group.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-grouping-statuses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupingStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterName", + "traits": { + "smithy.api#documentation": "The name of the filter. Filter names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValues", + "traits": { + "smithy.api#documentation": "One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.
" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilter" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterName": { + "type": "enum", + "members": { + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "status" + } + }, + "ResourceArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource-arn" + } + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^SUCCESS|FAILED|IN_PROGRESS|SKIPPED|arn:aws(-[a-z]+)*:[a-z0-9\\-]*:([a-z]{2}(-[a-z]+)+-\\d{1})?:([0-9]{12})?:.+$" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesInput": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupStringV2", + "traits": { + "smithy.api#documentation": "The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of resources and their statuses returned in the \n response.
" + } + }, + "Filters": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterList", + "traits": { + "smithy.api#documentation": "The filter name and value pair that is used to return more \n specific results from a list of resources.
" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the \n value provided by a previous call's NextToken response to indicate \n where the output should continue from.
The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
" + } + }, + "GroupingStatuses": { + "target": "com.amazonaws.resourcegroups#GroupingStatusesList", + "traits": { + "smithy.api#documentation": "Returns details about the grouping or ungrouping status of the \n resources in the specified application group.
" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "If present, indicates that more output is available than is included in the current response. \n Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. \n You should repeat this until the NextToken response element comes back as null.
Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.
\n resource-type - Filter the results to include only those resource groups that have the specified\n resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would\n return any resource group with a ResourceTypeFilter that includes\n AWS::EC2::Instance.
\n configuration-type - Filter the results to include only those\n groups that have the specified configuration types attached. The current\n supported values are:
\n AWS::AppRegistry::Application\n
\n AWS::AppRegistry::ApplicationResourceGroups\n
\n AWS::CloudFormation::Stack\n
\n AWS::EC2::CapacityReservationPool\n
\n AWS::EC2::HostManagement\n
\n AWS::NetworkFirewall::RuleGroup\n
Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.
\n resource-type - Filter the results to include only those resource groups that have the specified\n resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would\n return any resource group with a ResourceTypeFilter that includes\n AWS::EC2::Instance.
\n configuration-type - Filter the results to include only those\n groups that have the specified configuration types attached. The current\n supported values are:
\n AWS::ResourceGroups::ApplicationGroup\n
\n AWS::AppRegistry::Application\n
\n AWS::AppRegistry::ApplicationResourceGroups\n
\n AWS::CloudFormation::Stack\n
\n AWS::EC2::CapacityReservationPool\n
\n AWS::EC2::HostManagement\n
\n AWS::NetworkFirewall::RuleGroup\n
Returns a list of tag-sync tasks.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:ListTagSyncTasks with the group passed in the filters as the resource \n or * if using no filters
The Amazon resource name (ARN) of the application group.
" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "The name of the application group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a \n specified application group.
" + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksFilter" + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksInput": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksFilterList", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) or name of the application group for which you want to return a \n list of tag-sync tasks.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the \n value provided by a previous call's NextToken response to indicate \n where the output should continue from.
A list of tag-sync tasks and information about each task.
" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "If present, indicates that more output is available than is included in the current response. \n Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. \n You should repeat this until the NextToken response element comes back as null.
The name or ARN of the resource group with the configuration that you want to\n update.
" + "smithy.api#documentation": "The name or Amazon resource name (ARN) of the resource group with the configuration that you want to\n update.
" } }, "Configuration": { @@ -2767,7 +3492,7 @@ "ResourceArn": { "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { - "smithy.api#documentation": "The ARN of a resource.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of a resource.
" } }, "ResourceType": { @@ -2793,7 +3518,7 @@ "Type": { "target": "com.amazonaws.resourcegroups#QueryType", "traits": { - "smithy.api#documentation": "The type of the query to perform. This can have one of two values:
\n\n \n CLOUDFORMATION_STACK_1_0:\n Specifies that you\n want the group to contain the members of an CloudFormation stack. The Query\n contains a StackIdentifier element with an ARN for a CloudFormation\n stack.
\n \n TAG_FILTERS_1_0:\n Specifies that you want the\n group to include resource that have tags that match the query.
The type of the query to perform. This can have one of two values:
\n\n \n CLOUDFORMATION_STACK_1_0:\n Specifies that you\n want the group to contain the members of an CloudFormation stack. The Query\n contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation\n stack.
\n \n TAG_FILTERS_1_0:\n Specifies that you want the\n group to include resource that have tags that match the query.
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an \n application.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:StartTagSyncTask on the application group
\n resource-groups:CreateGroup\n
\n iam:PassRole on the role provided in the request
The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
", + "smithy.api#required": {} + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "The tag key. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.
", + "smithy.api#required": {} + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "The tag value. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#StartTagSyncTaskOutput": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the application group for which you want to add or remove resources.
" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "The name of the application group to onboard and sync resources.
" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the new tag-sync task.
" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "The tag key of the tag-sync task.
" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "The tag value of the tag-sync task.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#Tag": { "type": "operation", "input": { @@ -2965,7 +3820,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds tags to a resource group with the specified ARN. Existing tags on a resource\n group are not changed if they are not specified in the request parameters.
\nDo not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:Tag\n
Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource\n group are not changed if they are not specified in the request parameters.
\nDo not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\n\n resource-groups:Tag\n
The ARN of the resource group to which to add tags.
", + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group to which to add tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3016,9 +3871,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "The ARN of the tagged resource.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of the tagged resource.
" } }, "Tags": { @@ -3032,6 +3887,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#TagSyncTaskArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}$" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskItem": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the application group.
" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "The name of the application group.
" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the tag-sync task.
" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "The tag key.
" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "The tag value.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + }, + "Status": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskStatus", + "traits": { + "smithy.api#documentation": "The status of the tag-sync task.
\nValid values include:
\n\n ACTIVE - The tag-sync task is actively managing resources in \n the application by adding or removing the awsApplication tag from resources \n when they are tagged or untagged with the specified tag key-value pair. \n
\n ERROR - The tag-sync task is not actively managing resources \n in the application. Review the ErrorMessage for more information about \n resolving the error. \n
The specific error message in cases where the tag-sync task status\n is Error.
The timestamp of when the tag-sync task was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the tag-sync task.
" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskItem" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, "com.amazonaws.resourcegroups#TagValue": { "type": "string", "traits": { @@ -3118,16 +4068,16 @@ "type": "structure", "members": { "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group from which to remove the resources.
", + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group from which to remove the resources.
", "smithy.api#required": {} } }, "ResourceArns": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "The ARNs of the resources to be removed from the group.
", + "smithy.api#documentation": "The Amazon resource names (ARNs) of the resources to be removed from the group.
", "smithy.api#required": {} } } @@ -3203,9 +4153,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "The ARN of the resource group from which to remove tags. The command removed both the\n specified keys and any values associated with those keys.
", + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the\n specified keys and any values associated with those keys.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3226,9 +4176,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "The ARN of the resource group from which tags have been removed.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of the resource group from which tags have been removed.
" } }, "Keys": { @@ -3282,7 +4232,7 @@ "GroupLifecycleEventsDesiredStatus": { "target": "com.amazonaws.resourcegroups#GroupLifecycleEventsDesiredStatus", "traits": { - "smithy.api#documentation": "Specifies whether you want to turn group lifecycle events on or off.
" + "smithy.api#documentation": "Specifies whether you want to turn group lifecycle events on or off.
\nYou can't turn on group lifecycle events if your resource groups quota is greater than 2,000.
" } } }, @@ -3354,9 +4304,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group to modify.
" + "smithy.api#documentation": "The name or the ARN of the resource group to update.
" } }, "Description": { @@ -3364,6 +4314,24 @@ "traits": { "smithy.api#documentation": "The new description that you want to update the resource group with. Descriptions can\n contain letters, numbers, hyphens, underscores, periods, and spaces.
" } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.
" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the application group, which you can change at any time.
" + } } }, "traits": { @@ -3436,7 +4404,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "The name or the ARN of the resource group to query.
" + "smithy.api#documentation": "The name or the Amazon resource name (ARN) of the resource group to query.
" } }, "ResourceQuery": { @@ -3464,6 +4432,9 @@ "traits": { "smithy.api#output": {} } + }, + "com.amazonaws.resourcegroups#timestamp": { + "type": "timestamp" } } }