DescribeTagsRequest Class | AWS SDK for .NET V3

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

For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

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

public class DescribeTagsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeTagsRequest type exposes the following members

Constructors

	Name	Description
	DescribeTagsRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	DescribeTagsRequest(List<Filter>)	Instantiates DescribeTagsRequest with the parameterized properties

Properties

Name Type Description

Name	Type	Description
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.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken	System.String	Gets and sets the property NextToken. The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

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.

MaxResults

System.Int32

Gets and sets the property MaxResults.

The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

System.String

Gets and sets the property NextToken.

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

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