Use GetResources with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use GetResources with a CLI

The following code examples show how to use GetResources.

CLI
AWS CLI

To get a list of tagged resources

The following get-resources example displays a list of resources in the account that are tagged with the specified key name and value.

aws resourcegroupstaggingapi get-resources \ --tag-filters Key=Environment,Values=Production \ --tags-per-page 100

Output:

{ "ResourceTagMappingList": [ { "ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ] }

For more information, see GetResources in the Resource Groups Tagging API Reference.

  • For API details, see GetResources in AWS CLI Command Reference.

PowerShell
Tools for PowerShell

Example 1: 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.

Get-RGTResource

Output:

ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag}

Example 2: 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).

Get-RGTResource -ResourceType "s3"

Output:

ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag}

Example 3: 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.

"dynamodb","s3" | Get-RGTResource

Output:

ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag}

Example 4: Returns all the tagged resources that match the specified filter.

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

Output:

ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag}

Example 5: Returns all the tagged resources that match the specified filter and resource type.

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

Output:

ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}

Example 6: Returns all the tagged resources that match the specified filter.

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

Output:

ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
  • For API details, see GetResources in AWS Tools for PowerShell Cmdlet Reference.