AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Resource Groups Tagging API GetResources API operation.

Syntax

Get-RGTResource
-ResourceTypeFilter <String[]>
-ExcludeCompliantResource <Boolean>
-IncludeComplianceDetail <Boolean>
-ResourceARNList <String[]>
-ResourcesPerPage <Int32>
-TagFilter <TagFilter[]>
-TagsPerPage <Int32>
-PaginationToken <String>
-Select <String>
-PassThru <SwitchParameter>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonResourceGroupsTaggingAPIConfig>

Description

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account. Depending on what information you want returned, you can also specify the following:
  • Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
  • Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

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.

Parameters

-ClientConfig <AmazonResourceGroupsTaggingAPIConfig>
Amazon.PowerShell.Cmdlets.RGT.AmazonResourceGroupsTaggingAPIClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExcludeCompliantResource <Boolean>
Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExcludeCompliantResources
-IncludeComplianceDetail <Boolean>
Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncludeComplianceDetails
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of PaginationToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PaginationToken <String>
Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'PaginationToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-PaginationToken' to null for the first call then set the 'PaginationToken' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNextToken
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ResourceTypeFilter parameter. The -PassThru parameter is deprecated, use -Select '^ResourceTypeFilter' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceARNList <String[]>
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcesPerPage <Int32>
Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceTypeFilter <String[]>
Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:ec2:instance,s3:bucket,auditmanager
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
AliasesResourceTypeFilters
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTagMappingList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse). Specifying the name of a property of type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagFilter <TagFilter[]>
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values. Note the following when deciding how to use TagFilters:
  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].
  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.
  • If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
    • GetResources({filter1}) returns resources tagged with key1=value1
    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value
    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagFilters
-TagsPerPage <Int32>
Amazon Web Services recommends using ResourcesPerPage instead of this parameter.A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ResourceGroupsTaggingAPI.Model.ResourceTagMapping or Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse
This cmdlet returns a collection of Amazon.ResourceGroupsTaggingAPI.Model.ResourceTagMapping objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse) can be returned by specifying '-Select *'.

Examples

Example 1

Get-RGTResource

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}   
arn:aws:s3:::mybucket                                            {stage, version, othertag}
Returns all the tagged resources in a region and the tag keys associated with the resource. If no -Region parameter is supplied to the cmdlet it will attempt to infer region from the shell or EC2 instance metadata.

Example 2

Get-RGTResource -ResourceType "s3"

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:s3:::mybucket                                            {stage, version, othertag}
Returns all the tagged resources of the specified type in a region. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN).

Example 3

"dynamodb","s3" | Get-RGTResource

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}   
arn:aws:s3:::mybucket                                            {stage, version, othertag}
Returns all the tagged resources of the specified type in a region. Note that when the resource types are piped into the cmdlet, one call to the service is made for each supplied resource type.

Example 4

Get-RGTResource -TagFilter @{ Key="stage" }

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:s3:::mybucket                                            {stage, version, othertag}
Returns all the tagged resources that match the specified filter.

Example 5

Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}
Returns all the tagged resources that match the specified filter and resource type.

Example 6

Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }

ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}
Returns all the tagged resources that match the specified filter.
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z