AWS.Tools.ResourceGroups.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-RGResourceTag</name> <description> <para>Calls the AWS Resource Groups Tag API operation.</para> </description> <verb>Add</verb> <noun>RGResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. </para> </description> <syntax> <syntaxItem> <name>Add-RGResourceTag</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Tag</name> <description> <para>The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Arn</name> <description> <para>The ARN of the resource to which to add tags. </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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.TagResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.TagResponse 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 Tag parameter. The -PassThru parameter is deprecated, use -Select '^Tag' 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="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Arn</name> <description> <para>The ARN of the resource to which to add tags. </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>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 Tag parameter. The -PassThru parameter is deprecated, use -Select '^Tag' 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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.TagResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.TagResponse 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 (ByValue, ByPropertyName)" position="1"> <name>Tag</name> <description> <para>The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. </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>Amazon.ResourceGroups.Model.TagResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.TagResponse object containing multiple properties. The object 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-RGResourceTag.html&tocid=Add-RGResourceTag</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes Arn Tags --- ---- arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}</code><remarks><para>Description</para><para>-----------</para><para>This example adds tag key 'Instances' with value 'workboxes' to the given resource group arn</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>Find-RGResource</name> <description> <para>Calls the AWS Resource Groups SearchResources API operation.</para> </description> <verb>Find</verb> <noun>RGResource</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.<br /><br />In the AWS.Tools.ResourceGroups module, 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>Find-RGResource</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceQuery</name> <description> <para>The search query, using the same formats that are supported for resource group definition. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of group member ARNs returned by <code>SearchResources</code> in paginated output. By default, this number is 50. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated <code>SearchResources</code> request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <br /><b>Note:</b> In the AWS.Tools.ResourceGroups module, 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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.SearchResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.SearchResourcesResponse 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 ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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 NextToken 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>MaxResult</name> <description> <para>The maximum number of group member ARNs returned by <code>SearchResources</code> in paginated output. By default, this number is 50. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </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 (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated <code>SearchResources</code> request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <br /><b>Note:</b> In the AWS.Tools.ResourceGroups module, 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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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>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 NextToken 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>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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>ResourceQuery</name> <description> <para>The search query, using the same formats that are supported for resource group definition. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> <type> <name>Amazon.ResourceGroups.Model.ResourceQuery</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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.SearchResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.SearchResourcesResponse 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>Amazon.ResourceGroups.Model.SearchResourcesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.SearchResourcesResponse object containing multiple properties. The object 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=Find-RGResource.html&tocid=Find-RGResource</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new() $query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0 $query.Query = ConvertTo-Json -Compress -Depth 4 -InputObject @{ ResourceTypeFilters = @('AWS::EC2::Instance') TagFilters = @(@{ Key = 'auto' Values = @('no') }) } Find-RGResource -ResourceQuery $query | Select-Object -ExpandProperty ResourceIdentifiers ResourceArn ResourceType ----------- ------------ arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance</code><remarks><para>Description</para><para>-----------</para><para>This example creates a ResourceQuery for Instance resource types with tag filters and finds resources. </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-RGGroup</name> <description> <para>Calls the AWS Resource Groups GetGroup API operation.</para> </description> <verb>Get</verb> <noun>RGGroup</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a specified resource group. </para> </description> <syntax> <syntaxItem> <name>Get-RGGroup</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group. </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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetGroupResponse 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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </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>GroupName</name> <description> <para>The name of the resource group. </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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetGroupResponse 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>Amazon.ResourceGroups.Model.Group or Amazon.ResourceGroups.Model.GetGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.Group object. The service call response (type Amazon.ResourceGroups.Model.GetGroupResponse) 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-RGGroup.html&tocid=Get-RGGroup</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-RGGroup -GroupName auto-no Description GroupArn Name ----------- -------- ---- arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no</code><remarks><para>Description</para><para>-----------</para><para>This example retrieves resource group as per the group name</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-RGGroupList</name> <description> <para>Calls the AWS Resource Groups ListGroups API operation.</para> </description> <verb>Get</verb> <noun>RGGroupList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of existing resource groups in your 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-RGGroupList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Filter</name> <description> <para>Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation. - <code>resource-type</code> - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.GroupFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated <code>ListGroups</code> request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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 'GroupIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.ListGroupsResponse 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 Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' 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 NextToken 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 (ByValue, ByPropertyName)" position="1"> <name>Filter</name> <description> <para>Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation. - <code>resource-type</code> - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.GroupFilter[]</parameterValue> <type> <name>Amazon.ResourceGroups.Model.GroupFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </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 (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated <code>ListGroups</code> request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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>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 NextToken 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>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' 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 'GroupIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.ListGroupsResponse 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>Amazon.ResourceGroups.Model.GroupIdentifier or Amazon.ResourceGroups.Model.ListGroupsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.ResourceGroups.Model.GroupIdentifier objects. The service call response (type Amazon.ResourceGroups.Model.ListGroupsResponse) 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-RGGroupList.html&tocid=Get-RGGroupList</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-RGGroupList GroupArn GroupName -------- --------- arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes arn:aws:resource-groups:eu-west-1:123456789012:group/build600 build600</code><remarks><para>Description</para><para>-----------</para><para>This example lists resource group already created.</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-RGGroupQuery</name> <description> <para>Calls the AWS Resource Groups GetGroupQuery API operation.</para> </description> <verb>Get</verb> <noun>RGGroupQuery</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the resource query associated with the specified resource group. </para> </description> <syntax> <syntaxItem> <name>Get-RGGroupQuery</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group. </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 'GroupQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetGroupQueryResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetGroupQueryResponse 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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </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>GroupName</name> <description> <para>The name of the resource group. </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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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 'GroupQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetGroupQueryResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetGroupQueryResponse 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>Amazon.ResourceGroups.Model.GroupQuery or Amazon.ResourceGroups.Model.GetGroupQueryResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.GroupQuery object. The service call response (type Amazon.ResourceGroups.Model.GetGroupQueryResponse) 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-RGGroupQuery.html&tocid=Get-RGGroupQuery</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery Query Type ----- ---- {"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0</code><remarks><para>Description</para><para>-----------</para><para>This example fetches the resource query for the given resource group</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-RGGroupResourceList</name> <description> <para>Calls the AWS Resource Groups ListGroupResources API operation.</para> </description> <verb>Get</verb> <noun>RGGroupResourceList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of ARNs of resources that are members of a specified resource group.<br /><br />In the AWS.Tools.ResourceGroups module, 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-RGGroupResourceList</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Filter</name> <description> <para>Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. - <code>resource-type</code> - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <br /><b>Note:</b> In the AWS.Tools.ResourceGroups module, 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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.ListGroupResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.ListGroupResourcesResponse 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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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 NextToken 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>Filter</name> <description> <para>Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. - <code>resource-type</code> - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceFilter[]</parameterValue> <type> <name>Amazon.ResourceGroups.Model.ResourceFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group. </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>MaxResult</name> <description> <para>The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50. If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'. </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 (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. <br /><b>Note:</b> In the AWS.Tools.ResourceGroups module, 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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' 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>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 NextToken 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>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.ListGroupResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.ListGroupResourcesResponse 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>Amazon.ResourceGroups.Model.ListGroupResourcesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.ListGroupResourcesResponse object containing multiple properties. The object 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-RGGroupResourceList.html&tocid=Get-RGGroupResourceList</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers ResourceArn ResourceType ----------- ------------ arn:aws:ec2:eu-west-1:123456789012:instance/i-0123bc45b567890e1 AWS::EC2::Instance arn:aws:ec2:eu-west-1:123456789012:instance/i-0a1caf2345f67d8dc AWS::EC2::Instance arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa AWS::EC2::Instance arn:aws:ec2:eu-west-1:123456789012:instance/i-0fd12dd3456789012 AWS::EC2::Instance</code><remarks><para>Description</para><para>-----------</para><para>This example lists group resources on the basis of filtered by resource type</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-RGResourceTag</name> <description> <para>Calls the AWS Resource Groups GetTags API operation.</para> </description> <verb>Get</verb> <noun>RGResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of tags that are associated with a resource group, specified by an ARN. </para> </description> <syntax> <syntaxItem> <name>Get-RGResourceTag</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Arn</name> <description> <para>The ARN of the resource group for which you want a list of tags. The resource must exist within the account you are using. </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 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetTagsResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetTagsResponse 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 Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </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>Arn</name> <description> <para>The ARN of the resource group for which you want a list of tags. The resource must exist within the account you are using. </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 Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' 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 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.GetTagsResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.GetTagsResponse 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.ResourceGroups.Model.GetTagsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.ResourceGroups.Model.GetTagsResponse) 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-RGResourceTag.html&tocid=Get-RGResourceTag</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes Key Value --- ----- Instances workboxes</code><remarks><para>Description</para><para>-----------</para><para>This example lists tags for the given resource group arn</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>New-RGGroup</name> <description> <para>Calls the AWS Resource Groups CreateGroup API operation.</para> </description> <verb>New</verb> <noun>RGGroup</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a group with a specified name, description, and resource query. </para> </description> <syntax> <syntaxItem> <name>New-RGGroup</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceQuery</name> <description> <para>The resource query that determines which AWS resources are members of this group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Description</name> <description> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name must be unique within your 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>Tag</name> <description> <para>The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. </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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.CreateGroupResponse 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 ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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>Description</name> <description> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. </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>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="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name must be unique within your 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>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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>ResourceQuery</name> <description> <para>The resource query that determines which AWS resources are members of this group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> <type> <name>Amazon.ResourceGroups.Model.ResourceQuery</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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.CreateGroupResponse 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>Tag</name> <description> <para>The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. </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>Amazon.ResourceGroups.Model.CreateGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.CreateGroupResponse object containing multiple properties. The object 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=New-RGGroup.html&tocid=New-RGGroup</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $ResourceQuery = New-Object -TypeName Amazon.ResourceGroups.Model.ResourceQuery $ResourceQuery.Type = "TAG_FILTERS_1_0" $ResourceQuery.Query = '{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]}' $ResourceQuery New-RGGroup -Name TestPowerShellGroup -ResourceQuery $ResourceQuery -Description "Test resource group." Query Type ----- ---- {"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]} TAG_FILTERS_1_0 LoggedAt : 11/20/2018 2:40:59 PM Group : Amazon.ResourceGroups.Model.Group ResourceQuery : Amazon.ResourceGroups.Model.ResourceQuery Tags : {} ResponseMetadata : Amazon.Runtime.ResponseMetadata ContentLength : 338 HttpStatusCode : OK</code><remarks><para>Description</para><para>-----------</para><para>This example creates a new tag-based AWS Resource Groups resource group named TestPowerShellGroup. The group includes Amazon EC2 instances in the current region that are tagged with the tag key "Name", and tag value "test2". The command returns the query and type of group, and the results of the operation.</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-RGGroup</name> <description> <para>Calls the AWS Resource Groups DeleteGroup API operation.</para> </description> <verb>Remove</verb> <noun>RGGroup</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure. </para> </description> <syntax> <syntaxItem> <name>Remove-RGGroup</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group to delete. </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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.DeleteGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.DeleteGroupResponse 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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GroupName</name> <description> <para>The name of the resource group to delete. </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 GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' 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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.DeleteGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.DeleteGroupResponse 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>Amazon.ResourceGroups.Model.Group or Amazon.ResourceGroups.Model.DeleteGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.Group object. The service call response (type Amazon.ResourceGroups.Model.DeleteGroupResponse) 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-RGGroup.html&tocid=Remove-RGGroup</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-RGGroup -GroupName non-tag-cfn-elbv2 Confirm Are you sure you want to perform this action? Performing the operation "Remove-RGGroup (DeleteGroup)" on target "non-tag-cfn-elbv2". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y Description GroupArn Name ----------- -------- ---- arn:aws:resource-groups:eu-west-1:123456789012:group/non-tag-cfn-elbv2 non-tag-cfn-elbv2</code><remarks><para>Description</para><para>-----------</para><para>This example removes the named resource group</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-RGResourceTag</name> <description> <para>Calls the AWS Resource Groups Untag API operation.</para> </description> <verb>Remove</verb> <noun>RGResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes specified tags from a specified resource. </para> </description> <syntax> <syntaxItem> <name>Remove-RGResourceTag</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The keys of the tags to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Arn</name> <description> <para>The ARN of the resource from which to remove tags. </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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UntagResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UntagResponse 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>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="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Arn</name> <description> <para>The ARN of the resource from which to remove tags. </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>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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The keys of the tags to be removed. </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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UntagResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UntagResponse 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>Amazon.ResourceGroups.Model.UntagResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.UntagResponse object containing multiple properties. The object 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-RGResourceTag.html&tocid=Remove-RGResourceTag</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances Confirm Are you sure you want to perform this action? Performing the operation "Remove-RGResourceTag (Untag)" on target "arn:aws:resource-groups:eu-west-1:933303704102:group/workboxes". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y Arn Keys --- ---- arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {Instances}</code><remarks><para>Description</para><para>-----------</para><para>This example removes mentioned tag from the resource group</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>Update-RGGroup</name> <description> <para>Calls the AWS Resource Groups UpdateGroup API operation.</para> </description> <verb>Update</verb> <noun>RGGroup</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing group with a new or changed description. You cannot update the name of a resource group. </para> </description> <syntax> <syntaxItem> <name>Update-RGGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Description</name> <description> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GroupName</name> <description> <para>The name of the resource group for which you want to update its description. </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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UpdateGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UpdateGroupResponse 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 Description parameter. The -PassThru parameter is deprecated, use -Select '^Description' 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 (ByValue, ByPropertyName)" position="1"> <name>Description</name> <description> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. </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>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="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GroupName</name> <description> <para>The name of the resource group for which you want to update its description. </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 Description parameter. The -PassThru parameter is deprecated, use -Select '^Description' 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 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UpdateGroupResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UpdateGroupResponse 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>Amazon.ResourceGroups.Model.Group or Amazon.ResourceGroups.Model.UpdateGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.Group object. The service call response (type Amazon.ResourceGroups.Model.UpdateGroupResponse) 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=Update-RGGroup.html&tocid=Update-RGGroup</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove" Description GroupArn Name ----------- -------- ---- Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes</code><remarks><para>Description</para><para>-----------</para><para>This example updates the description of the group</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>Update-RGGroupQuery</name> <description> <para>Calls the AWS Resource Groups UpdateGroupQuery API operation.</para> </description> <verb>Update</verb> <noun>RGGroupQuery</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the resource query of a group. </para> </description> <syntax> <syntaxItem> <name>Update-RGGroupQuery</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceQuery</name> <description> <para>The resource query that determines which AWS resources are members of the resource group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GroupName</name> <description> <para>The name of the resource group for which you want to edit the query. </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 'GroupQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UpdateGroupQueryResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UpdateGroupQueryResponse 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 ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GroupName</name> <description> <para>The name of the resource group for which you want to edit the query. </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 ResourceQuery parameter. The -PassThru parameter is deprecated, use -Select '^ResourceQuery' 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>ResourceQuery</name> <description> <para>The resource query that determines which AWS resources are members of the resource group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroups.Model.ResourceQuery</parameterValue> <type> <name>Amazon.ResourceGroups.Model.ResourceQuery</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 'GroupQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.UpdateGroupQueryResponse). Specifying the name of a property of type Amazon.ResourceGroups.Model.UpdateGroupQueryResponse 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>Amazon.ResourceGroups.Model.GroupQuery or Amazon.ResourceGroups.Model.UpdateGroupQueryResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.ResourceGroups.Model.GroupQuery object. The service call response (type Amazon.ResourceGroups.Model.UpdateGroupQueryResponse) 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=Update-RGGroupQuery.html&tocid=Update-RGGroupQuery</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>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new() $query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0 $query.Query = @{ ResourceTypeFilters = @('AWS::EC2::Instance') TagFilters = @(@{ Key='Environment' Values='Build600.11' }) } | ConvertTo-Json -Compress -Depth 4 Update-RGGroupQuery -GroupName build600 -ResourceQuery $query GroupName ResourceQuery --------- ------------- build600 Amazon.ResourceGroups.Model.ResourceQuery</code><remarks><para>Description</para><para>-----------</para><para>This example creates a query object and updates the query for the group.</para><para /><para /></remarks> </example> </examples> </command> </helpItems> |