AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest Class Reference

#include <GetResourcesRequest.h>

+ Inheritance diagram for Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest:

Public Member Functions

 GetResourcesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPaginationToken () const
 
bool PaginationTokenHasBeenSet () const
 
void SetPaginationToken (const Aws::String &value)
 
void SetPaginationToken (Aws::String &&value)
 
void SetPaginationToken (const char *value)
 
GetResourcesRequestWithPaginationToken (const Aws::String &value)
 
GetResourcesRequestWithPaginationToken (Aws::String &&value)
 
GetResourcesRequestWithPaginationToken (const char *value)
 
const Aws::Vector< TagFilter > & GetTagFilters () const
 
bool TagFiltersHasBeenSet () const
 
void SetTagFilters (const Aws::Vector< TagFilter > &value)
 
void SetTagFilters (Aws::Vector< TagFilter > &&value)
 
GetResourcesRequestWithTagFilters (const Aws::Vector< TagFilter > &value)
 
GetResourcesRequestWithTagFilters (Aws::Vector< TagFilter > &&value)
 
GetResourcesRequestAddTagFilters (const TagFilter &value)
 
GetResourcesRequestAddTagFilters (TagFilter &&value)
 
int GetResourcesPerPage () const
 
bool ResourcesPerPageHasBeenSet () const
 
void SetResourcesPerPage (int value)
 
GetResourcesRequestWithResourcesPerPage (int value)
 
int GetTagsPerPage () const
 
bool TagsPerPageHasBeenSet () const
 
void SetTagsPerPage (int value)
 
GetResourcesRequestWithTagsPerPage (int value)
 
const Aws::Vector< Aws::String > & GetResourceTypeFilters () const
 
bool ResourceTypeFiltersHasBeenSet () const
 
void SetResourceTypeFilters (const Aws::Vector< Aws::String > &value)
 
void SetResourceTypeFilters (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestWithResourceTypeFilters (const Aws::Vector< Aws::String > &value)
 
GetResourcesRequestWithResourceTypeFilters (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestAddResourceTypeFilters (const Aws::String &value)
 
GetResourcesRequestAddResourceTypeFilters (Aws::String &&value)
 
GetResourcesRequestAddResourceTypeFilters (const char *value)
 
bool GetIncludeComplianceDetails () const
 
bool IncludeComplianceDetailsHasBeenSet () const
 
void SetIncludeComplianceDetails (bool value)
 
GetResourcesRequestWithIncludeComplianceDetails (bool value)
 
bool GetExcludeCompliantResources () const
 
bool ExcludeCompliantResourcesHasBeenSet () const
 
void SetExcludeCompliantResources (bool value)
 
GetResourcesRequestWithExcludeCompliantResources (bool value)
 
const Aws::Vector< Aws::String > & GetResourceARNList () const
 
bool ResourceARNListHasBeenSet () const
 
void SetResourceARNList (const Aws::Vector< Aws::String > &value)
 
void SetResourceARNList (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestWithResourceARNList (const Aws::Vector< Aws::String > &value)
 
GetResourcesRequestWithResourceARNList (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestAddResourceARNList (const Aws::String &value)
 
GetResourcesRequestAddResourceARNList (Aws::String &&value)
 
GetResourcesRequestAddResourceARNList (const char *value)
 
- Public Member Functions inherited from Aws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest
virtual ~ResourceGroupsTaggingAPIRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file GetResourcesRequest.h.

Constructor & Destructor Documentation

◆ GetResourcesRequest()

Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetResourcesRequest ( )

Member Function Documentation

◆ AddResourceARNList() [1/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceARNList ( Aws::String &&  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 793 of file GetResourcesRequest.h.

◆ AddResourceARNList() [2/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceARNList ( const Aws::String value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 778 of file GetResourcesRequest.h.

◆ AddResourceARNList() [3/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceARNList ( const char *  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 808 of file GetResourcesRequest.h.

◆ AddResourceTypeFilters() [1/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceTypeFilters ( Aws::String &&  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 589 of file GetResourcesRequest.h.

◆ AddResourceTypeFilters() [2/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceTypeFilters ( const Aws::String value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 572 of file GetResourcesRequest.h.

◆ AddResourceTypeFilters() [3/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddResourceTypeFilters ( const char *  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 606 of file GetResourcesRequest.h.

◆ AddTagFilters() [1/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddTagFilters ( const TagFilter value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 304 of file GetResourcesRequest.h.

◆ AddTagFilters() [2/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::AddTagFilters ( TagFilter &&  value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 334 of file GetResourcesRequest.h.

◆ ExcludeCompliantResourcesHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::ExcludeCompliantResourcesHasBeenSet ( ) const
inline

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Definition at line 654 of file GetResourcesRequest.h.

◆ GetExcludeCompliantResources()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetExcludeCompliantResources ( ) const
inline

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Definition at line 645 of file GetResourcesRequest.h.

◆ GetIncludeComplianceDetails()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetIncludeComplianceDetails ( ) const
inline

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Definition at line 614 of file GetResourcesRequest.h.

◆ GetPaginationToken()

const Aws::String& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetPaginationToken ( ) const
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 44 of file GetResourcesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetResourceARNList()

const Aws::Vector<Aws::String>& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetResourceARNList ( ) const
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 688 of file GetResourcesRequest.h.

◆ GetResourcesPerPage()

int Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetResourcesPerPage ( ) const
inline

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 PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Definition at line 344 of file GetResourcesRequest.h.

◆ GetResourceTypeFilters()

const Aws::Vector<Aws::String>& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetResourceTypeFilters ( ) const
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 470 of file GetResourcesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetResourcesRequest.h.

◆ GetTagFilters()

const Aws::Vector<TagFilter>& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetTagFilters ( ) const
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 124 of file GetResourcesRequest.h.

◆ GetTagsPerPage()

int Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::GetTagsPerPage ( ) const
inline

AWS recommends using ResourcesPerPage instead of this parameter.

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

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

Definition at line 392 of file GetResourcesRequest.h.

◆ IncludeComplianceDetailsHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::IncludeComplianceDetailsHasBeenSet ( ) const
inline

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Definition at line 621 of file GetResourcesRequest.h.

◆ PaginationTokenHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::PaginationTokenHasBeenSet ( ) const
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 51 of file GetResourcesRequest.h.

◆ ResourceARNListHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::ResourceARNListHasBeenSet ( ) const
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 703 of file GetResourcesRequest.h.

◆ ResourcesPerPageHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::ResourcesPerPageHasBeenSet ( ) const
inline

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 PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Definition at line 353 of file GetResourcesRequest.h.

◆ ResourceTypeFiltersHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::ResourceTypeFiltersHasBeenSet ( ) const
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 487 of file GetResourcesRequest.h.

◆ SerializePayload()

Aws::String Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExcludeCompliantResources()

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetExcludeCompliantResources ( bool  value)
inline

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Definition at line 663 of file GetResourcesRequest.h.

◆ SetIncludeComplianceDetails()

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetIncludeComplianceDetails ( bool  value)
inline

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Definition at line 628 of file GetResourcesRequest.h.

◆ SetPaginationToken() [1/3]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetPaginationToken ( Aws::String &&  value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 65 of file GetResourcesRequest.h.

◆ SetPaginationToken() [2/3]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetPaginationToken ( const Aws::String value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 58 of file GetResourcesRequest.h.

◆ SetPaginationToken() [3/3]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetPaginationToken ( const char *  value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 72 of file GetResourcesRequest.h.

◆ SetResourceARNList() [1/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetResourceARNList ( Aws::Vector< Aws::String > &&  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 733 of file GetResourcesRequest.h.

◆ SetResourceARNList() [2/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetResourceARNList ( const Aws::Vector< Aws::String > &  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 718 of file GetResourcesRequest.h.

◆ SetResourcesPerPage()

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetResourcesPerPage ( int  value)
inline

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 PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Definition at line 362 of file GetResourcesRequest.h.

◆ SetResourceTypeFilters() [1/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetResourceTypeFilters ( Aws::Vector< Aws::String > &&  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 521 of file GetResourcesRequest.h.

◆ SetResourceTypeFilters() [2/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetResourceTypeFilters ( const Aws::Vector< Aws::String > &  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 504 of file GetResourcesRequest.h.

◆ SetTagFilters() [1/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetTagFilters ( Aws::Vector< TagFilter > &&  value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 214 of file GetResourcesRequest.h.

◆ SetTagFilters() [2/2]

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetTagFilters ( const Aws::Vector< TagFilter > &  value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 184 of file GetResourcesRequest.h.

◆ SetTagsPerPage()

void Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::SetTagsPerPage ( int  value)
inline

AWS recommends using ResourcesPerPage instead of this parameter.

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

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

Definition at line 432 of file GetResourcesRequest.h.

◆ TagFiltersHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::TagFiltersHasBeenSet ( ) const
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 154 of file GetResourcesRequest.h.

◆ TagsPerPageHasBeenSet()

bool Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::TagsPerPageHasBeenSet ( ) const
inline

AWS recommends using ResourcesPerPage instead of this parameter.

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

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

Definition at line 412 of file GetResourcesRequest.h.

◆ WithExcludeCompliantResources()

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithExcludeCompliantResources ( bool  value)
inline

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Definition at line 672 of file GetResourcesRequest.h.

◆ WithIncludeComplianceDetails()

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithIncludeComplianceDetails ( bool  value)
inline

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Definition at line 635 of file GetResourcesRequest.h.

◆ WithPaginationToken() [1/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithPaginationToken ( Aws::String &&  value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 86 of file GetResourcesRequest.h.

◆ WithPaginationToken() [2/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithPaginationToken ( const Aws::String value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 79 of file GetResourcesRequest.h.

◆ WithPaginationToken() [3/3]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithPaginationToken ( const char *  value)
inline

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Definition at line 93 of file GetResourcesRequest.h.

◆ WithResourceARNList() [1/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithResourceARNList ( Aws::Vector< Aws::String > &&  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 763 of file GetResourcesRequest.h.

◆ WithResourceARNList() [2/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithResourceARNList ( const Aws::Vector< Aws::String > &  value)
inline

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 (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

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 AWS Service Namespaces in the AWS General Reference.

Definition at line 748 of file GetResourcesRequest.h.

◆ WithResourcesPerPage()

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithResourcesPerPage ( int  value)
inline

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 PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Definition at line 371 of file GetResourcesRequest.h.

◆ WithResourceTypeFilters() [1/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithResourceTypeFilters ( Aws::Vector< Aws::String > &&  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 555 of file GetResourcesRequest.h.

◆ WithResourceTypeFilters() [2/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithResourceTypeFilters ( const Aws::Vector< Aws::String > &  value)
inline

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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:

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Definition at line 538 of file GetResourcesRequest.h.

◆ WithTagFilters() [1/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithTagFilters ( Aws::Vector< TagFilter > &&  value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 274 of file GetResourcesRequest.h.

◆ WithTagFilters() [2/2]

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithTagFilters ( const Aws::Vector< TagFilter > &  value)
inline

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify any values for a key, the response returns resources that are tagged with that key and any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

Definition at line 244 of file GetResourcesRequest.h.

◆ WithTagsPerPage()

GetResourcesRequest& Aws::ResourceGroupsTaggingAPI::Model::GetResourcesRequest::WithTagsPerPage ( int  value)
inline

AWS recommends using ResourcesPerPage instead of this parameter.

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

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

Definition at line 452 of file GetResourcesRequest.h.


The documentation for this class was generated from the following file: