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 or previously tagged resources that are located in the specified Amazon Web Services Region for the account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages.
You should check the PaginationToken
response parameter to determine if there
are additional results available to return. Repeat the query, passing the PaginationToken
response parameter value as an input to the next request until you recieve a null
value. A null value for PaginationToken
indicates that there are no more results
waiting to be returned.
Namespace: Amazon.ResourceGroupsTaggingAPI.Model
Assembly: AWSSDK.ResourceGroupsTaggingAPI.dll
Version: 3.x.y.z
public class GetResourcesRequest : AmazonResourceGroupsTaggingAPIRequest IAmazonWebServiceRequest
The GetResourcesRequest type exposes the following members
Name | Description | |
---|---|---|
GetResourcesRequest() |
Name | Type | Description | |
---|---|---|---|
ExcludeCompliantResources | System.Boolean |
Gets and sets the property ExcludeCompliantResources.
Specifies whether to exclude resources that are compliant with the tag policy. Set
this to
You can use this parameter only if the |
|
IncludeComplianceDetails | System.Boolean |
Gets and sets the property IncludeComplianceDetails.
Specifies whether to include details regarding the compliance with the effective tag
policy. Set this to |
|
PaginationToken | System.String |
Gets and sets the property PaginationToken.
Specifies a |
|
ResourceARNList | System.Collections.Generic.List<System.String> |
Gets and sets the property ResourceARNList.
Specifies a list of ARNs of resources for which you want to retrieve tag data. You
can't specify both this parameter and any of the pagination parameters ( If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response. An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. |
|
ResourcesPerPage | System.Int32 |
Gets and sets the property ResourcesPerPage.
Specifies the maximum number of results to be returned in each page. A query can return
fewer than this maximum, even if there are more results still to return. You should
always check the |
|
ResourceTypeFilters | System.Collections.Generic.List<System.String> |
Gets and sets the property ResourceTypeFilters.
Specifies the resource types that you want included in the response. The format of
each resource type is The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API. You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
|
|
TagFilters | System.Collections.Generic.List<Amazon.ResourceGroupsTaggingAPI.Model.TagFilter> |
Gets and sets the property TagFilters.
Specifies a list of TagFilters (keys and values) to restrict the output to only those
resources that have tags with the specified keys and, if included, the specified values.
Each Note the following when deciding how to use TagFilters:
|
|
TagsPerPage | System.Int32 |
Gets and sets the property TagsPerPage.
Amazon Web Services recommends using
A limit that restricts the number of tags (key and value pairs) returned by
You can set |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5