AWS.Tools.ResourceGroups.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ResourceGroups</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.RG.AddRGResourceTagCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.AddRGResourceTagCmdlet.Arn"> <summary> <para> <para>The ARN of the resource to which to add tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.AddRGResourceTagCmdlet.Tag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.AddRGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.FindRGResourceCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.FindRGResourceCmdlet.ResourceQuery"> <summary> <para> <para>The search query, using the same formats that are supported for resource group definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.FindRGResourceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of group member ARNs returned by <code>SearchResources</code> in paginated output. By default, this number is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.FindRGResourceCmdlet.NextToken"> <summary> <para> <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.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.GetRGGroupCmdlet"> <summary> Returns information about a specified resource group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupCmdlet.GroupName"> <summary> <para> <para>The name of the resource group.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.GetRGGroupListCmdlet"> <summary> Returns a list of existing resource groups in your account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupListCmdlet.Filter"> <summary> <para> <para>Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.</para><ul><li><para><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></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupListCmdlet.NextToken"> <summary> <para> <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.</para> </para> <para> <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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.GetRGGroupQueryCmdlet"> <summary> Returns the resource query associated with the specified resource group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupQueryCmdlet.GroupName"> <summary> <para> <para>The name of the resource group.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.GetRGGroupResourceListCmdlet"> <summary> Returns a list of ARNs of resources that are members of a specified resource group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupResourceListCmdlet.Filter"> <summary> <para> <para>Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.</para><ul><li><para><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></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupResourceListCmdlet.GroupName"> <summary> <para> <para>The name of the resource group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupResourceListCmdlet.MaxResult"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGGroupResourceListCmdlet.NextToken"> <summary> <para> <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.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.GetRGResourceTagCmdlet"> <summary> Returns a list of tags that are associated with a resource group, specified by an ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.GetRGResourceTagCmdlet.Arn"> <summary> <para> <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> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet"> <summary> Creates a group with a specified name, description, and resource query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet.Description"> <summary> <para> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet.Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet.ResourceQuery"> <summary> <para> <para>The resource query that determines which AWS resources are members of this group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet.Tag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.NewRGGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.RemoveRGGroupCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.RemoveRGGroupCmdlet.GroupName"> <summary> <para> <para>The name of the resource group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.RemoveRGGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.RemoveRGResourceTagCmdlet"> <summary> Deletes specified tags from a specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.RemoveRGResourceTagCmdlet.Arn"> <summary> <para> <para>The ARN of the resource from which to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.RemoveRGResourceTagCmdlet.Key"> <summary> <para> <para>The keys of the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.RemoveRGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupCmdlet"> <summary> Updates an existing group with a new or changed description. You cannot update the name of a resource group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupCmdlet.Description"> <summary> <para> <para>The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupCmdlet.GroupName"> <summary> <para> <para>The name of the resource group for which you want to update its description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupQueryCmdlet"> <summary> Updates the resource query of a group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupQueryCmdlet.GroupName"> <summary> <para> <para>The name of the resource group for which you want to edit the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupQueryCmdlet.ResourceQuery"> <summary> <para> <para>The resource query that determines which AWS resources are members of the resource group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RG.UpdateRGGroupQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |