Resource Groups: TagSyncTasks can be created with ResourceQuery

Author: aws-sdk-dotnet-automation

generator/ServiceModels/resource-groups/resource-groups-2017-11-27.api.json

@@ -601,6 +601,7 @@
         "TaskArn":{"shape":"TagSyncTaskArn"},
         "TagKey":{"shape":"TagKey"},
         "TagValue":{"shape":"TagValue"},
+        "ResourceQuery":{"shape":"ResourceQuery"},
         "RoleArn":{"shape":"RoleArn"},
         "Status":{"shape":"TagSyncTaskStatus"},
         "ErrorMessage":{"shape":"ErrorMessage"},
@@ -1218,14 +1219,13 @@
       "type":"structure",
       "required":[
         "Group",
-        "TagKey",
-        "TagValue",
         "RoleArn"
       ],
       "members":{
         "Group":{"shape":"GroupStringV2"},
         "TagKey":{"shape":"TagKey"},
         "TagValue":{"shape":"TagValue"},
+        "ResourceQuery":{"shape":"ResourceQuery"},
         "RoleArn":{"shape":"RoleArn"}
       }
     },
@@ -1237,6 +1237,7 @@
         "TaskArn":{"shape":"TagSyncTaskArn"},
         "TagKey":{"shape":"TagKey"},
         "TagValue":{"shape":"TagValue"},
+        "ResourceQuery":{"shape":"ResourceQuery"},
         "RoleArn":{"shape":"RoleArn"}
       }
     },
@@ -1286,6 +1287,7 @@
         "TaskArn":{"shape":"TagSyncTaskArn"},
         "TagKey":{"shape":"TagKey"},
         "TagValue":{"shape":"TagValue"},
+        "ResourceQuery":{"shape":"ResourceQuery"},
         "RoleArn":{"shape":"RoleArn"},
         "Status":{"shape":"TagSyncTaskStatus"},
         "ErrorMessage":{"shape":"ErrorMessage"},

generator/ServiceModels/resource-groups/resource-groups-2017-11-27.docs.json

@@ -18,7 +18,7 @@
     "ListTagSyncTasks": "<p>Returns a list of tag-sync tasks. </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:ListTagSyncTasks</code> with the group passed in the filters as the resource or * if using no filters </p> </li> </ul>",
     "PutGroupConfiguration": "<p>Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use <a>GetGroupConfiguration</a> to check the status of the update.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:PutGroupConfiguration</code> </p> </li> </ul>",
     "SearchResources": "<p>Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a <a>CreateGroup</a> or <a>UpdateGroupQuery</a> operation.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:SearchResources</code> </p> </li> <li> <p> <code>cloudformation:DescribeStacks</code> </p> </li> <li> <p> <code>cloudformation:ListStackResources</code> </p> </li> <li> <p> <code>tag:GetResources</code> </p> </li> </ul>",
-    "StartTagSyncTask": "<p>Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:StartTagSyncTask</code> on the application group</p> </li> <li> <p> <code>resource-groups:CreateGroup</code> </p> </li> <li> <p> <code>iam:PassRole</code> on the role provided in the request </p> </li> </ul>",
+    "StartTagSyncTask": "<p>Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an 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> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:StartTagSyncTask</code> on the application group</p> </li> <li> <p> <code>resource-groups:CreateGroup</code> </p> </li> <li> <p> <code>iam:PassRole</code> on the role provided in the request </p> </li> </ul>",
     "Tag": "<p>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.</p> <important> <p>Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.</p> </important> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:Tag</code> </p> </li> </ul>",
     "UngroupResources": "<p>Removes the specified resources from the specified group. This operation works only with static groups that you populated using the <a>GroupResources</a> operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:UngroupResources</code> </p> </li> </ul>",
     "Untag": "<p>Deletes tags from a specified resource group.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:Untag</code> </p> </li> </ul>",
@@ -316,7 +316,7 @@
     "GroupFilterList": {
       "base": null,
       "refs": {
-        "ListGroupsInput$Filters": "<p>Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to a <code>ListGroups</code> operation.</p> <ul> <li> <p> <code>resource-type</code> - Filter the results to include only those resource groups that have the specified resource type in their <code>ResourceTypeFilter</code>. For example, <code>AWS::EC2::Instance</code> would return any resource group with a <code>ResourceTypeFilter</code> that includes <code>AWS::EC2::Instance</code>.</p> </li> <li> <p> <code>configuration-type</code> - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:</p> <ul> <li> <p> <code>AWS::ResourceGroups::ApplicationGroup</code> </p> </li> <li> <p> <code>AWS::AppRegistry::Application</code> </p> </li> <li> <p> <code>AWS::AppRegistry::ApplicationResourceGroups</code> </p> </li> <li> <p> <code>AWS::CloudFormation::Stack</code> </p> </li> <li> <p> <code>AWS::EC2::CapacityReservationPool</code> </p> </li> <li> <p> <code>AWS::EC2::HostManagement</code> </p> </li> <li> <p> <code>AWS::NetworkFirewall::RuleGroup</code> </p> </li> </ul> </li> </ul>"
+        "ListGroupsInput$Filters": "<p>Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to a <code>ListGroups</code> operation.</p> <ul> <li> <p> <code>resource-type</code> - Filter the results to include only those resource groups that have the specified resource type in their <code>ResourceTypeFilter</code>. For example, <code>AWS::EC2::Instance</code> would return any resource group with a <code>ResourceTypeFilter</code> that includes <code>AWS::EC2::Instance</code>.</p> </li> <li> <p> <code>configuration-type</code> - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:</p> <ul> <li> <p> <code>AWS::ResourceGroups::ApplicationGroup</code> </p> </li> <li> <p> <code>AWS::AppRegistry::Application</code> </p> </li> <li> <p> <code>AWS::AppRegistry::ApplicationResourceGroup</code> </p> </li> <li> <p> <code>AWS::CloudFormation::Stack</code> </p> </li> <li> <p> <code>AWS::EC2::CapacityReservationPool</code> </p> </li> <li> <p> <code>AWS::EC2::HostManagement</code> </p> </li> <li> <p> <code>AWS::NetworkFirewall::RuleGroup</code> </p> </li> </ul> </li> </ul>"
       }
     },
     "GroupFilterName": {
@@ -733,8 +733,12 @@
       "refs": {
         "CreateGroupInput$ResourceQuery": "<p>The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see <a href=\"https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag\">Create a tag-based group in Resource Groups</a>. </p> <note> <p>A resource group can contain either a <code>ResourceQuery</code> or a <code>Configuration</code>, but not both.</p> </note>",
         "CreateGroupOutput$ResourceQuery": "<p>The resource query associated with the group. For more information about resource queries, see <a href=\"https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag\">Create a tag-based group in Resource Groups</a>. </p>",
+        "GetTagSyncTaskOutput$ResourceQuery": null,
         "GroupQuery$ResourceQuery": "<p>The resource query that determines which Amazon Web Services resources are members of the associated resource group.</p>",
         "SearchResourcesInput$ResourceQuery": "<p>The search query, using the same formats that are supported for resource group definition. For more information, see <a>CreateGroup</a>.</p>",
+        "StartTagSyncTaskInput$ResourceQuery": "<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>",
+        "StartTagSyncTaskOutput$ResourceQuery": null,
+        "TagSyncTaskItem$ResourceQuery": null,
         "UpdateGroupQueryInput$ResourceQuery": "<p>The resource query to determine which Amazon Web Services resources are members of this resource group.</p> <note> <p>A resource group can contain either a <code>Configuration</code> or a <code>ResourceQuery</code>, but not both.</p> </note>"
       }
     },
@@ -794,7 +798,7 @@
       "base": null,
       "refs": {
         "GetTagSyncTaskOutput$TagKey": "<p>The tag key. </p>",
-        "StartTagSyncTaskInput$TagKey": "<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>",
+        "StartTagSyncTaskInput$TagKey": "<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>",
         "StartTagSyncTaskOutput$TagKey": "<p>The tag key of the tag-sync task. </p>",
         "TagKeyList$member": null,
         "TagSyncTaskItem$TagKey": "<p>The tag key. </p>",
@@ -846,7 +850,7 @@
       "base": null,
       "refs": {
         "GetTagSyncTaskOutput$TagValue": "<p>The tag value. </p>",
-        "StartTagSyncTaskInput$TagValue": "<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>",
+        "StartTagSyncTaskInput$TagValue": "<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>",
         "StartTagSyncTaskOutput$TagValue": "<p>The tag value of the tag-sync task. </p>",
         "TagSyncTaskItem$TagValue": "<p>The tag value. </p>",
         "Tags$value": null