AWS SDK Version 3 for .NET
API 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.

Container for the parameters to the DescribeTags operation. Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeTagsRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeTagsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeTagsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeTagsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method DescribeTagsRequest(List<Filter>)

Instantiates DescribeTagsRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Filters System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property Filters.

The filters.

  • key - The tag key.

  • resource-id - The ID of the resource.

  • resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).

  • tag: - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

  • value - The tag value.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token to retrieve the next page of results.

Examples

This example describes the tags for the specified instance.

To describe the tags for a single resource


var client = new AmazonEC2Client();
var response = client.DescribeTags(new DescribeTagsRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "resource-id",
            Values = new List<string> {
                "i-1234567890abcdef8"
            }
        }
    }
});

List<TagDescription> tags = response.Tags;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5