AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::ResourceGroups::Model::ListGroupResourcesRequest Class Reference

#include <ListGroupResourcesRequest.h>

+ Inheritance diagram for Aws::ResourceGroups::Model::ListGroupResourcesRequest:

Public Member Functions

 ListGroupResourcesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetGroup () const
 
bool GroupHasBeenSet () const
 
void SetGroup (const Aws::String &value)
 
void SetGroup (Aws::String &&value)
 
void SetGroup (const char *value)
 
ListGroupResourcesRequestWithGroup (const Aws::String &value)
 
ListGroupResourcesRequestWithGroup (Aws::String &&value)
 
ListGroupResourcesRequestWithGroup (const char *value)
 
const Aws::Vector< ResourceFilter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< ResourceFilter > &value)
 
void SetFilters (Aws::Vector< ResourceFilter > &&value)
 
ListGroupResourcesRequestWithFilters (const Aws::Vector< ResourceFilter > &value)
 
ListGroupResourcesRequestWithFilters (Aws::Vector< ResourceFilter > &&value)
 
ListGroupResourcesRequestAddFilters (const ResourceFilter &value)
 
ListGroupResourcesRequestAddFilters (ResourceFilter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListGroupResourcesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListGroupResourcesRequestWithNextToken (const Aws::String &value)
 
ListGroupResourcesRequestWithNextToken (Aws::String &&value)
 
ListGroupResourcesRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::ResourceGroups::ResourceGroupsRequest
virtual ~ResourceGroupsRequest ()
 
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::ResourceGroups::ResourceGroupsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file ListGroupResourcesRequest.h.

Constructor & Destructor Documentation

◆ ListGroupResourcesRequest()

Aws::ResourceGroups::Model::ListGroupResourcesRequest::ListGroupResourcesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::AddFilters ( const ResourceFilter value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 251 of file ListGroupResourcesRequest.h.

◆ AddFilters() [2/2]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::AddFilters ( ResourceFilter &&  value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 276 of file ListGroupResourcesRequest.h.

◆ FiltersHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupResourcesRequest::FiltersHasBeenSet ( ) const
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 126 of file ListGroupResourcesRequest.h.

◆ GetFilters()

const Aws::Vector<ResourceFilter>& Aws::ResourceGroups::Model::ListGroupResourcesRequest::GetFilters ( ) const
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 101 of file ListGroupResourcesRequest.h.

◆ GetGroup()

const Aws::String& Aws::ResourceGroups::Model::ListGroupResourcesRequest::GetGroup ( ) const
inline

The name or the ARN of the resource group

Definition at line 40 of file ListGroupResourcesRequest.h.

◆ GetMaxResults()

int Aws::ResourceGroups::Model::ListGroupResourcesRequest::GetMaxResults ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 290 of file ListGroupResourcesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ResourceGroups::Model::ListGroupResourcesRequest::GetNextToken ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 339 of file ListGroupResourcesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ResourceGroups::Model::ListGroupResourcesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListGroupResourcesRequest.h.

◆ GroupHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupResourcesRequest::GroupHasBeenSet ( ) const
inline

The name or the ARN of the resource group

Definition at line 45 of file ListGroupResourcesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupResourcesRequest::MaxResultsHasBeenSet ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 303 of file ListGroupResourcesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupResourcesRequest::NextTokenHasBeenSet ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 348 of file ListGroupResourcesRequest.h.

◆ SerializePayload()

Aws::String Aws::ResourceGroups::Model::ListGroupResourcesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetFilters ( Aws::Vector< ResourceFilter > &&  value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 176 of file ListGroupResourcesRequest.h.

◆ SetFilters() [2/2]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetFilters ( const Aws::Vector< ResourceFilter > &  value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 151 of file ListGroupResourcesRequest.h.

◆ SetGroup() [1/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetGroup ( Aws::String &&  value)
inline

The name or the ARN of the resource group

Definition at line 55 of file ListGroupResourcesRequest.h.

◆ SetGroup() [2/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetGroup ( const Aws::String value)
inline

The name or the ARN of the resource group

Definition at line 50 of file ListGroupResourcesRequest.h.

◆ SetGroup() [3/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetGroup ( const char *  value)
inline

The name or the ARN of the resource group

Definition at line 60 of file ListGroupResourcesRequest.h.

◆ SetMaxResults()

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 316 of file ListGroupResourcesRequest.h.

◆ SetNextToken() [1/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 366 of file ListGroupResourcesRequest.h.

◆ SetNextToken() [2/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 357 of file ListGroupResourcesRequest.h.

◆ SetNextToken() [3/3]

void Aws::ResourceGroups::Model::ListGroupResourcesRequest::SetNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 375 of file ListGroupResourcesRequest.h.

◆ WithFilters() [1/2]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithFilters ( Aws::Vector< ResourceFilter > &&  value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 226 of file ListGroupResourcesRequest.h.

◆ WithFilters() [2/2]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithFilters ( const Aws::Vector< ResourceFilter > &  value)
inline

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

  • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

The resource types specified as filters in the request are not valid.

The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).

Definition at line 201 of file ListGroupResourcesRequest.h.

◆ WithGroup() [1/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithGroup ( Aws::String &&  value)
inline

The name or the ARN of the resource group

Definition at line 70 of file ListGroupResourcesRequest.h.

◆ WithGroup() [2/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithGroup ( const Aws::String value)
inline

The name or the ARN of the resource group

Definition at line 65 of file ListGroupResourcesRequest.h.

◆ WithGroup() [3/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithGroup ( const char *  value)
inline

The name or the ARN of the resource group

Definition at line 75 of file ListGroupResourcesRequest.h.

◆ WithMaxResults()

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 329 of file ListGroupResourcesRequest.h.

◆ WithNextToken() [1/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 393 of file ListGroupResourcesRequest.h.

◆ WithNextToken() [2/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 384 of file ListGroupResourcesRequest.h.

◆ WithNextToken() [3/3]

ListGroupResourcesRequest& Aws::ResourceGroups::Model::ListGroupResourcesRequest::WithNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 402 of file ListGroupResourcesRequest.h.


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