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

Invokes the DescribeTags operation against Amazon Elastic Compute Cloud.

Syntax

Get-EC2Tag
-Filter <Filter[]>
-MaxResult <Int32>
-NextToken <String>

Description

Describes one or more of the tags for your EC2 resources. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

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.

Parameters

-Filter <Filter[]>
One or more filters.
  • key - The tag key.
  • resource-id - The resource ID.
  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).
  • value - The tag value.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-MaxResult <Int32>
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
Required?False
Position?Named
Accept pipeline input?False
-NextToken <String>
The token to retrieve the next page of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a Filter[] object to this cmdlet for the Filter parameter.

Outputs

This cmdlet returns a collection of TagDescription objects. The service call response (type Amazon.EC2.Model.DescribeTagsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)

Examples

Example 1

PS C:\> Get-EC2Tag -Filter @{ Name="key";Values="mytag"}

Key ResourceId ResourceType Value
--- ---------- ------------ -----
mytag i-12345678 instance myTagValue
myTag vol-12345678 volume newTagValue
myTag snap-12345678 snapshot newTagValue
This example describes the tags with the specified key.

Example 2

PS C:\> Get-EC2Tag -Filter @{ Name="key";Values="myTag"},@{ Name="value";Values="myTagValue"}
This example describes the tags with the specified key and value.

Example 3

PS C:\> $keys = New-Object string[] 1
PS C:\> $keys[0] = "myTag"
PS C:\> $filter = New-Object Amazon.EC2.Model.Filter
PS C:\> $filter.Name = "key"
PS C:\> $filter.Values = $keys

PS C:\> Get-EC2Tag -Filter @( $filter )
This example describes the tags with the specified key.

Example 4

PS C:\> $keys = New-Object string[] 1
PS C:\> $keys[0] = "myTag"
PS C:\> $filter1 = New-Object Amazon.EC2.Model.Filter
PS C:\> $filter1.Name = "key"
PS C:\> $filter1.Values = $keys

PS C:\> $values = New-Object string[] 1
PS C:\> $values[0] = "myTagValue"
PS C:\> $filter2 = New-Object Amazon.EC2.Model.Filter
PS C:\> $filter2.Name = "value"
PS C:\> $filter2.Values = $values

PS C:\> Get-EC2Tag -Filter @( $filter1, filter2 )
This example describes the tags with the specified key and value.

Example 5

PS C:\> Get-EC2Tag
This example describes all tags for all your EC2 resources.

Supported Version

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