AWS.Tools.ResourceGroupsTaggingAPI.dll-Help.xml
|
<helpItems schema="maml">
<command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Add-RGTResourceTag</name> <description> <para>Calls the AWS Resource Groups Tagging API TagResources API operation.</para> </description> <verb>Add</verb> <noun>RGTResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Applies one or more tags to the specified resources. Note the following: - Not all resources can have tags. For a list of resources that support tagging, see <a href="http://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Supported Resources</a> in the <i>AWS Resource Groups User Guide</i>. - Each resource can have up to 50 tags. For other limits, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions">Tag Restrictions</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. - You can only tag resources that are located in the specified region for the AWS account. - To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see <a href="http://docs.aws.amazon.com/ARG/latest/userguide/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Add-RGTResourceTag</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>The tags that you want to add to the specified resources. A tag consists of a key and a value that you define. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'FailedResourcesMap'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceARNList parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARNList' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceARNList parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARNList' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'FailedResourcesMap'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>The tags that you want to add to the specified resources. A tag consists of a key and a value that you define. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-RGTResourceTag.html&tocid=Add-RGTResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" } </code><remarks><para>Description</para><para>-----------</para><para>This example adds the tag keys "stage" and "version" with values "beta" and "preprod_test" to an Amazon S3 bucket and an Amazon DynamoDB table. A single call is made to the service to apply the tags.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> $arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" } </code><remarks><para>Description</para><para>-----------</para><para>This example adds the specified tags and values to an Amazon S3 bucket and an Amazon DynamoDB table. Two calls are made to the service, one for each resource ARN piped into the cmdlet.</para><para /><para /></remarks> </example> </examples> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-RGTResource</name> <description> <para>Calls the AWS Resource Groups Tagging API GetResources API operation.</para> </description> <verb>Get</verb> <noun>RGTResource</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify <i>filters</i> (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources. You can check the <code>PaginationToken</code> response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The <code>PaginationToken</code> response parameter value is <code>null</code><i>only</i> when there are no more results to display. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-RGTResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceTypeFilter</name> <description> <para>The constraints on the resources that you want returned. The format of each resource type is <code>service[:resourceType]</code>. For example, specifying a resource type of <code>ec2</code> returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <i>AWS General Reference</i> for the following: - For a list of service name strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">AWS Service Namespaces</a>. - For resource type strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example ARNs</a>. - For more information about ARNs, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ResourcesPerPage</name> <description> <para>A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagFilter</name> <description> <para>A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values. Note the following when deciding how to use TagFilters: - If you <i>do</i> specify a TagFilter, the response returns only those resources that are currently associated with the specified tag. - If you <i>don't</i> specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: <code>"Tags": []</code>. - If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters. - If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key. - If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value. For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}: - GetResources( {filter1} ) returns resources tagged with key1=value1 - GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4 - GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value - GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value) </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagsPerPage</name> <description> <para>A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). <code>GetResources</code> does not split a resource and its associated tags across pages. If the specified <code>TagsPerPage</code> would cause such a break, a <code>PaginationToken</code> is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a <code>TagsPerPage</code> of <code>100</code> and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set <code>TagsPerPage</code> to a minimum of 100 items and the maximum of 500 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a <code>PaginationToken</code>, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTagMappingList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceTypeFilter parameter. The -PassThru parameter is deprecated, use -Select '^ResourceTypeFilter' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a <code>PaginationToken</code>, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceTypeFilter parameter. The -PassThru parameter is deprecated, use -Select '^ResourceTypeFilter' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ResourcesPerPage</name> <description> <para>A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceTypeFilter</name> <description> <para>The constraints on the resources that you want returned. The format of each resource type is <code>service[:resourceType]</code>. For example, specifying a resource type of <code>ec2</code> returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <i>AWS General Reference</i> for the following: - For a list of service name strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">AWS Service Namespaces</a>. - For resource type strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example ARNs</a>. - For more information about ARNs, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTagMappingList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagFilter</name> <description> <para>A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values. Note the following when deciding how to use TagFilters: - If you <i>do</i> specify a TagFilter, the response returns only those resources that are currently associated with the specified tag. - If you <i>don't</i> specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: <code>"Tags": []</code>. - If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters. - If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key. - If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value. For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}: - GetResources( {filter1} ) returns resources tagged with key1=value1 - GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4 - GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value - GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value) </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</parameterValue> <type> <name>Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagsPerPage</name> <description> <para>A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). <code>GetResources</code> does not split a resource and its associated tags across pages. If the specified <code>TagsPerPage</code> would cause such a break, a <code>PaginationToken</code> is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a <code>TagsPerPage</code> of <code>100</code> and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set <code>TagsPerPage</code> to a minimum of 100 items and the maximum of 500 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ResourceGroupsTaggingAPI.Model.ResourceTagMapping or Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.ResourceGroupsTaggingAPI.Model.ResourceTagMapping objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTResource.html&tocid=Get-RGTResource</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTResource ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources in a region and the tag keys associated with the resource. If no -Region parameter is supplied to the cmdlet it will attempt to infer region from the shell or EC2 instance metadata.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> Get-RGTResource -ResourceType "s3" ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources of the specified type in a region. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN).</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\> "dynamodb","s3" | Get-RGTResource ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources of the specified type in a region. Note that when the resource types are piped into the cmdlet, one call to the service is made for each supplied resource type.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage" } ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter and resource type.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter.</para><para /><para /></remarks> </example> </examples> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-RGTTagKey</name> <description> <para>Calls the AWS Resource Groups Tagging API GetTagKeys API operation.</para> </description> <verb>Get</verb> <noun>RGTTagKey</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all tag keys in the specified region for the AWS account.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-RGTTagKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'TagKeys'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'TagKeys'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTTagKey.html&tocid=Get-RGTTagKey</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTTagKey -region us-west-2 version stage </code><remarks><para>Description</para><para>-----------</para><para>Returns all tag keys in the specified region. If the -Region parameter is not specified the cmdlet will attempt to infer the region from the default shell region or EC2 instance metadata. Note that the tag keys are not returned in any specific order.</para><para /><para /></remarks> </example> </examples> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-RGTTagValue</name> <description> <para>Calls the AWS Resource Groups Tagging API GetTagValues API operation.</para> </description> <verb>Get</verb> <noun>RGTTagValue</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all tag values for the specified key in the specified region for the AWS account.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-RGTTagValue</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key for which you want to list all existing values in the specified region for the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'TagValues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Key parameter. The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key for which you want to list all existing values in the specified region for the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-PaginationToken $null' for the first call and '-PaginationToken $AWSHistory.LastServiceResponse.PaginationToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Key parameter. The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'TagValues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTTagValue.html&tocid=Get-RGTTagValue</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTTagValue -Key "stage" -Region us-west-2 beta </code><remarks><para>Description</para><para>-----------</para><para>Returns the value for the specified tag in a region. If the -Region parameter is not specified the cmdlet will attempt to infer the region from the default shell region or EC2 instance metadata.</para><para /><para /></remarks> </example> </examples> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-RGTResourceTag</name> <description> <para>Calls the AWS Resource Groups Tagging API UntagResources API operation.</para> </description> <verb>Remove</verb> <noun>RGTResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: - To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see <a href="http://docs.aws.amazon.com/ARG/latest/userguide/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups User Guide</i>. - You can only tag resources that are located in the specified region for the AWS account. </para> </description> <syntax> <syntaxItem> <name>Remove-RGTResourceTag</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagKey</name> <description> <para>A list of the tag keys that you want to remove from the specified resources. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'FailedResourcesMap'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceARNList parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARNList' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceARNList parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARNList' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'FailedResourcesMap'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TagKey</name> <description> <para>A list of the tag keys that you want to remove from the specified resources. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-RGTResourceTag.html&tocid=Remove-RGTResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version" </code><remarks><para>Description</para><para>-----------</para><para>Removes the tag keys "stage" and "version", and the associated values, from an Amazon S3 bucket and an Amazon DynamoDB table. A single call is made to the service to remove the tags. Before the tags are removed the cmdlet will prompt for confirmation. To bypass confirmation add the -Force parameter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> $arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version" </code><remarks><para>Description</para><para>-----------</para><para>Removes the tag keys "stage" and "version", and the associated values, from an Amazon S3 bucket and an Amazon DynamoDB table. Two calls are made to the service, one for each resource ARN piped into the cmdlet. Before each call the cmdlet will prompt for confirmation. To bypass confirmation add the -Force parameter.</para><para /><para /></remarks> </example> </examples> </command> </helpItems> |