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 GetResources operation. Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ResourceGroupsTaggingAPI.AmazonResourceGroupsTaggingAPIRequest
      Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesRequest

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

Syntax

C#
public class GetResourcesRequest : AmazonResourceGroupsTaggingAPIRequest
         IAmazonWebServiceRequest

The GetResourcesRequest type exposes the following members

Constructors

NameDescription
Public Method GetResourcesRequest()

Properties

NameTypeDescription
Public Property PaginationToken System.String

Gets and sets the property PaginationToken.

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Public Property ResourcesPerPage System.Int32

Gets and sets the property ResourcesPerPage.

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.

Public Property ResourceTypeFilters System.Collections.Generic.List<System.String>

Gets and sets the property ResourceTypeFilters.

The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all tagged Amazon EC2 resources (which includes tagged 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). Consult the AWS General Reference for the following:

Public Property TagFilters System.Collections.Generic.List<Amazon.ResourceGroupsTaggingAPI.Model.TagFilter>

Gets and sets the property TagFilters.

A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

Public Property TagsPerPage System.Int32

Gets and sets the property TagsPerPage.

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 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms