@aws-sdk/client-resource-groups 3.782.0 → 3.790.0

package/dist-cjs/index.js

@@ -707,6 +707,7 @@ var se_StartTagSyncTaskCommand = /* @__PURE__ */ __name(async (input, context) =
   body = JSON.stringify(
     (0, import_smithy_client.take)(input, {
       Group: [],
+      ResourceQuery: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "ResourceQuery"),
       RoleArn: [],
       TagKey: [],
       TagValue: []
@@ -940,6 +941,7 @@ var de_GetTagSyncTaskCommand = /* @__PURE__ */ __name(async (output, context) =>
     ErrorMessage: import_smithy_client.expectString,
     GroupArn: import_smithy_client.expectString,
     GroupName: import_smithy_client.expectString,
+    ResourceQuery: import_smithy_client._json,
     RoleArn: import_smithy_client.expectString,
     Status: import_smithy_client.expectString,
     TagKey: import_smithy_client.expectString,
@@ -1066,6 +1068,7 @@ var de_StartTagSyncTaskCommand = /* @__PURE__ */ __name(async (output, context)
   const doc = (0, import_smithy_client.take)(data, {
     GroupArn: import_smithy_client.expectString,
     GroupName: import_smithy_client.expectString,
+    ResourceQuery: import_smithy_client._json,
     RoleArn: import_smithy_client.expectString,
     TagKey: import_smithy_client.expectString,
     TagValue: import_smithy_client.expectString,
@@ -1313,6 +1316,7 @@ var de_TagSyncTaskItem = /* @__PURE__ */ __name((output, context) => {
     ErrorMessage: import_smithy_client.expectString,
     GroupArn: import_smithy_client.expectString,
     GroupName: import_smithy_client.expectString,
+    ResourceQuery: import_smithy_client._json,
     RoleArn: import_smithy_client.expectString,
     Status: import_smithy_client.expectString,
     TagKey: import_smithy_client.expectString,

package/dist-es/protocols/Aws_restJson1.js

@@ -238,6 +238,7 @@ export const se_StartTagSyncTaskCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         Group: [],
+        ResourceQuery: (_) => _json(_),
         RoleArn: [],
         TagKey: [],
         TagValue: [],
@@ -458,6 +459,7 @@ export const de_GetTagSyncTaskCommand = async (output, context) => {
         ErrorMessage: __expectString,
         GroupArn: __expectString,
         GroupName: __expectString,
+        ResourceQuery: _json,
         RoleArn: __expectString,
         Status: __expectString,
         TagKey: __expectString,
@@ -584,6 +586,7 @@ export const de_StartTagSyncTaskCommand = async (output, context) => {
     const doc = take(data, {
         GroupArn: __expectString,
         GroupName: __expectString,
+        ResourceQuery: _json,
         RoleArn: __expectString,
         TagKey: __expectString,
         TagValue: __expectString,
@@ -833,6 +836,7 @@ const de_TagSyncTaskItem = (output, context) => {
         ErrorMessage: __expectString,
         GroupArn: __expectString,
         GroupName: __expectString,
+        ResourceQuery: _json,
         RoleArn: __expectString,
         Status: __expectString,
         TagKey: __expectString,

package/dist-types/commands/GetTagSyncTaskCommand.d.ts

@@ -55,6 +55,10 @@ declare const GetTagSyncTaskCommand_base: {
  * //   TaskArn: "STRING_VALUE",
  * //   TagKey: "STRING_VALUE",
  * //   TagValue: "STRING_VALUE",
+ * //   ResourceQuery: { // ResourceQuery
+ * //     Type: "TAG_FILTERS_1_0" || "CLOUDFORMATION_STACK_1_0", // required
+ * //     Query: "STRING_VALUE", // required
+ * //   },
  * //   RoleArn: "STRING_VALUE",
  * //   Status: "ACTIVE" || "ERROR",
  * //   ErrorMessage: "STRING_VALUE",

package/dist-types/commands/ListTagSyncTasksCommand.d.ts

@@ -65,6 +65,10 @@ declare const ListTagSyncTasksCommand_base: {
  * //       TaskArn: "STRING_VALUE",
  * //       TagKey: "STRING_VALUE",
  * //       TagValue: "STRING_VALUE",
+ * //       ResourceQuery: { // ResourceQuery
+ * //         Type: "TAG_FILTERS_1_0" || "CLOUDFORMATION_STACK_1_0", // required
+ * //         Query: "STRING_VALUE", // required
+ * //       },
  * //       RoleArn: "STRING_VALUE",
  * //       Status: "ACTIVE" || "ERROR",
  * //       ErrorMessage: "STRING_VALUE",

package/dist-types/commands/StartTagSyncTaskCommand.d.ts

@@ -28,7 +28,11 @@ declare const StartTagSyncTaskCommand_base: {
 };
 /**
  * <p>Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an
- *             application. </p>
+ *             application. To start a tag-sync task, you need a <a href="https://docs.aws.amazon.com/servicecatalog/latest/arguide/app-tag-sync.html#tag-sync-role">resource tagging role</a>.
+ *             The resource tagging role grants permissions to tag and untag applications resources and must include a
+ *         trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. </p>
+ *          <p>For instructions on creating a tag-sync task, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/arguide/app-tag-sync.html#create-tag-sync">Create a tag-sync
+ *             using the Resource Groups API</a> in the <i>Amazon Web Services Service Catalog AppRegistry Administrator Guide</i>.  </p>
  *          <p>
  *             <b>Minimum permissions</b>
  *          </p>
@@ -56,8 +60,12 @@ declare const StartTagSyncTaskCommand_base: {
  * const client = new ResourceGroupsClient(config);
  * const input = { // StartTagSyncTaskInput
  *   Group: "STRING_VALUE", // required
- *   TagKey: "STRING_VALUE", // required
- *   TagValue: "STRING_VALUE", // required
+ *   TagKey: "STRING_VALUE",
+ *   TagValue: "STRING_VALUE",
+ *   ResourceQuery: { // ResourceQuery
+ *     Type: "TAG_FILTERS_1_0" || "CLOUDFORMATION_STACK_1_0", // required
+ *     Query: "STRING_VALUE", // required
+ *   },
  *   RoleArn: "STRING_VALUE", // required
  * };
  * const command = new StartTagSyncTaskCommand(input);
@@ -68,6 +76,10 @@ declare const StartTagSyncTaskCommand_base: {
  * //   TaskArn: "STRING_VALUE",
  * //   TagKey: "STRING_VALUE",
  * //   TagValue: "STRING_VALUE",
+ * //   ResourceQuery: { // ResourceQuery
+ * //     Type: "TAG_FILTERS_1_0" || "CLOUDFORMATION_STACK_1_0", // required
+ * //     Query: "STRING_VALUE", // required
+ * //   },
  * //   RoleArn: "STRING_VALUE",
  * // };
  *

package/dist-types/models/models_0.d.ts

@@ -773,6 +773,37 @@ export interface GetTagSyncTaskOutput {
      * @public
      */
     TagValue?: string | undefined;
+    /**
+     * <p>The query you can use to define a resource group or a search for resources. A
+     *                 <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
+     *                 <code>Query</code> string as JSON string objects. See the examples section for
+     *             example JSON strings. For more information about creating a resource group with a
+     *             resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html">Build queries and groups in
+     *                 Resource Groups</a> in the <i>Resource Groups User Guide</i>
+     *          </p>
+     *          <p>When you combine all of the elements together into a single string, any double quotes
+     *             that are embedded inside another double quote pair must be escaped by preceding the
+     *             embedded double quote with a backslash character (\). For example, a complete
+     *                 <code>ResourceQuery</code> parameter must be formatted like the following CLI
+     *             parameter example:</p>
+     *          <p>
+     *             <code>--resource-query
+     *                 '\{"Type":"TAG_FILTERS_1_0","Query":"\{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[\{\"Key\":\"Stage\",\"Values\":[\"Test\"]\}]\}"\}'</code>
+     *          </p>
+     *          <p>In the preceding example, all of the double quote characters in the value part of the
+     *                 <code>Query</code> element must be escaped because the value itself is surrounded by
+     *             double quotes. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
+     *                 strings</a> in the <i>Command Line Interface User Guide</i>.</p>
+     *          <p>For the complete list of resource types that you can use in the array value for
+     *                 <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources
+     *                 you can use with Resource Groups and Tag Editor</a> in the
+     *                 <i>Resource Groups User Guide</i>. For example:</p>
+     *          <p>
+     *             <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
+     *          </p>
+     * @public
+     */
+    ResourceQuery?: ResourceQuery | undefined;
     /**
      * <p>The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf. </p>
      *          <p>For more information about this role, review <a href="https://docs.aws.amazon.com/servicecatalog/latest/arguide/app-tag-sync.html#tag-sync-role">Tag-sync required permissions</a>.
@@ -1346,7 +1377,7 @@ export interface ListGroupsInput {
      *                   </li>
      *                   <li>
      *                      <p>
-     *                         <code>AWS::AppRegistry::ApplicationResourceGroups</code>
+     *                         <code>AWS::AppRegistry::ApplicationResourceGroup</code>
      *                      </p>
      *                   </li>
      *                   <li>
@@ -1540,6 +1571,37 @@ export interface TagSyncTaskItem {
      * @public
      */
     TagValue?: string | undefined;
+    /**
+     * <p>The query you can use to define a resource group or a search for resources. A
+     *                 <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
+     *                 <code>Query</code> string as JSON string objects. See the examples section for
+     *             example JSON strings. For more information about creating a resource group with a
+     *             resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html">Build queries and groups in
+     *                 Resource Groups</a> in the <i>Resource Groups User Guide</i>
+     *          </p>
+     *          <p>When you combine all of the elements together into a single string, any double quotes
+     *             that are embedded inside another double quote pair must be escaped by preceding the
+     *             embedded double quote with a backslash character (\). For example, a complete
+     *                 <code>ResourceQuery</code> parameter must be formatted like the following CLI
+     *             parameter example:</p>
+     *          <p>
+     *             <code>--resource-query
+     *                 '\{"Type":"TAG_FILTERS_1_0","Query":"\{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[\{\"Key\":\"Stage\",\"Values\":[\"Test\"]\}]\}"\}'</code>
+     *          </p>
+     *          <p>In the preceding example, all of the double quote characters in the value part of the
+     *                 <code>Query</code> element must be escaped because the value itself is surrounded by
+     *             double quotes. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
+     *                 strings</a> in the <i>Command Line Interface User Guide</i>.</p>
+     *          <p>For the complete list of resource types that you can use in the array value for
+     *                 <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources
+     *                 you can use with Resource Groups and Tag Editor</a> in the
+     *                 <i>Resource Groups User Guide</i>. For example:</p>
+     *          <p>
+     *             <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
+     *          </p>
+     * @public
+     */
+    ResourceQuery?: ResourceQuery | undefined;
     /**
      * <p>The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.</p>
      * @public
@@ -1712,16 +1774,51 @@ export interface StartTagSyncTaskInput {
      * <p>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. </p>
+     *          <p>When using the <code>TagKey</code> parameter, you must also specify the <code>TagValue</code> parameter. If you specify a tag key-value pair,
+     *             you can't use the <code>ResourceQuery</code> parameter. </p>
      * @public
      */
-    TagKey: string | undefined;
+    TagKey?: string | undefined;
     /**
      * <p>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. </p>
+     *          <p>When using the <code>TagValue</code> parameter, you must also specify the <code>TagKey</code> parameter. If you specify a tag key-value pair,
+     *             you can't use the <code>ResourceQuery</code> parameter. </p>
      * @public
      */
-    TagValue: string | undefined;
+    TagValue?: string | undefined;
+    /**
+     * <p>The query you can use to create the tag-sync task. With this method, all resources matching the query
+     *             are added to the specified application group. A
+     *             <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
+     *                 <code>Query</code> string as JSON string objects. For more information on defining a resource query for a
+     *                 tag-sync task, see the tag-based query type in <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#getting_started-query_types">
+     *                     Types of resource group queries</a> in <i>Resource Groups User Guide</i>. </p>
+     *          <p>When using the <code>ResourceQuery</code> parameter, you cannot use the <code>TagKey</code> and <code>TagValue</code> parameters. </p>
+     *          <p>When you combine all of the elements together into a single string, any double quotes
+     *             that are embedded inside another double quote pair must be escaped by preceding the
+     *             embedded double quote with a backslash character (\). For example, a complete
+     *             <code>ResourceQuery</code> parameter must be formatted like the following CLI
+     *             parameter example:</p>
+     *          <p>
+     *             <code>--resource-query
+     *             '\{"Type":"TAG_FILTERS_1_0","Query":"\{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[\{\"Key\":\"Stage\",\"Values\":[\"Test\"]\}]\}"\}'</code>
+     *          </p>
+     *          <p>In the preceding example, all of the double quote characters in the value part of the
+     *             <code>Query</code> element must be escaped because the value itself is surrounded by
+     *             double quotes. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
+     *                 strings</a> in the <i>Command Line Interface User Guide</i>.</p>
+     *          <p>For the complete list of resource types that you can use in the array value for
+     *             <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources
+     *                 you can use with Resource Groups and Tag Editor</a> in the
+     *             <i>Resource Groups User Guide</i>. For example:</p>
+     *          <p>
+     *             <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
+     *          </p>
+     * @public
+     */
+    ResourceQuery?: ResourceQuery | undefined;
     /**
      * <p>The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.</p>
      * @public
@@ -1757,6 +1854,37 @@ export interface StartTagSyncTaskOutput {
      * @public
      */
     TagValue?: string | undefined;
+    /**
+     * <p>The query you can use to define a resource group or a search for resources. A
+     *                 <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
+     *                 <code>Query</code> string as JSON string objects. See the examples section for
+     *             example JSON strings. For more information about creating a resource group with a
+     *             resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html">Build queries and groups in
+     *                 Resource Groups</a> in the <i>Resource Groups User Guide</i>
+     *          </p>
+     *          <p>When you combine all of the elements together into a single string, any double quotes
+     *             that are embedded inside another double quote pair must be escaped by preceding the
+     *             embedded double quote with a backslash character (\). For example, a complete
+     *                 <code>ResourceQuery</code> parameter must be formatted like the following CLI
+     *             parameter example:</p>
+     *          <p>
+     *             <code>--resource-query
+     *                 '\{"Type":"TAG_FILTERS_1_0","Query":"\{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[\{\"Key\":\"Stage\",\"Values\":[\"Test\"]\}]\}"\}'</code>
+     *          </p>
+     *          <p>In the preceding example, all of the double quote characters in the value part of the
+     *                 <code>Query</code> element must be escaped because the value itself is surrounded by
+     *             double quotes. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
+     *                 strings</a> in the <i>Command Line Interface User Guide</i>.</p>
+     *          <p>For the complete list of resource types that you can use in the array value for
+     *                 <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources
+     *                 you can use with Resource Groups and Tag Editor</a> in the
+     *                 <i>Resource Groups User Guide</i>. For example:</p>
+     *          <p>
+     *             <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
+     *          </p>
+     * @public
+     */
+    ResourceQuery?: ResourceQuery | undefined;
     /**
      * <p>The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.</p>
      * @public

package/dist-types/ts3.4/models/models_0.d.ts

@@ -187,6 +187,7 @@ export interface GetTagSyncTaskOutput {
   TaskArn?: string | undefined;
   TagKey?: string | undefined;
   TagValue?: string | undefined;
+  ResourceQuery?: ResourceQuery | undefined;
   RoleArn?: string | undefined;
   Status?: TagSyncTaskStatus | undefined;
   ErrorMessage?: string | undefined;
@@ -347,6 +348,7 @@ export interface TagSyncTaskItem {
   TaskArn?: string | undefined;
   TagKey?: string | undefined;
   TagValue?: string | undefined;
+  ResourceQuery?: ResourceQuery | undefined;
   RoleArn?: string | undefined;
   Status?: TagSyncTaskStatus | undefined;
   ErrorMessage?: string | undefined;
@@ -373,8 +375,9 @@ export interface SearchResourcesOutput {
 }
 export interface StartTagSyncTaskInput {
   Group: string | undefined;
-  TagKey: string | undefined;
-  TagValue: string | undefined;
+  TagKey?: string | undefined;
+  TagValue?: string | undefined;
+  ResourceQuery?: ResourceQuery | undefined;
   RoleArn: string | undefined;
 }
 export interface StartTagSyncTaskOutput {
@@ -383,6 +386,7 @@ export interface StartTagSyncTaskOutput {
   TaskArn?: string | undefined;
   TagKey?: string | undefined;
   TagValue?: string | undefined;
+  ResourceQuery?: ResourceQuery | undefined;
   RoleArn?: string | undefined;
 }
 export interface TagInput {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-resource-groups",
   "description": "AWS SDK for JavaScript Resource Groups Client for Node.js, Browser and React Native",
-  "version": "3.782.0",
+  "version": "3.790.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-resource-groups",
@@ -21,16 +21,16 @@
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
     "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.782.0",
+    "@aws-sdk/credential-provider-node": "3.787.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",
-    "@aws-sdk/middleware-user-agent": "3.782.0",
+    "@aws-sdk/middleware-user-agent": "3.787.0",
     "@aws-sdk/region-config-resolver": "3.775.0",
     "@aws-sdk/types": "3.775.0",
-    "@aws-sdk/util-endpoints": "3.782.0",
+    "@aws-sdk/util-endpoints": "3.787.0",
     "@aws-sdk/util-user-agent-browser": "3.775.0",
-    "@aws-sdk/util-user-agent-node": "3.782.0",
+    "@aws-sdk/util-user-agent-node": "3.787.0",
     "@smithy/config-resolver": "^4.1.0",
     "@smithy/core": "^3.2.0",
     "@smithy/fetch-http-handler": "^5.0.2",