AWS SDK for C++  1.9.161
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::ResourceGroups::ResourceGroupsClient Class Reference

#include <ResourceGroupsClient.h>

+ Inheritance diagram for Aws::ResourceGroups::ResourceGroupsClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 ResourceGroupsClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ResourceGroupsClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ResourceGroupsClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~ResourceGroupsClient ()
 
virtual Model::CreateGroupOutcome CreateGroup (const Model::CreateGroupRequest &request) const
 
virtual Model::CreateGroupOutcomeCallable CreateGroupCallable (const Model::CreateGroupRequest &request) const
 
virtual void CreateGroupAsync (const Model::CreateGroupRequest &request, const CreateGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteGroupOutcome DeleteGroup (const Model::DeleteGroupRequest &request) const
 
virtual Model::DeleteGroupOutcomeCallable DeleteGroupCallable (const Model::DeleteGroupRequest &request) const
 
virtual void DeleteGroupAsync (const Model::DeleteGroupRequest &request, const DeleteGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetGroupOutcome GetGroup (const Model::GetGroupRequest &request) const
 
virtual Model::GetGroupOutcomeCallable GetGroupCallable (const Model::GetGroupRequest &request) const
 
virtual void GetGroupAsync (const Model::GetGroupRequest &request, const GetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetGroupConfigurationOutcome GetGroupConfiguration (const Model::GetGroupConfigurationRequest &request) const
 
virtual Model::GetGroupConfigurationOutcomeCallable GetGroupConfigurationCallable (const Model::GetGroupConfigurationRequest &request) const
 
virtual void GetGroupConfigurationAsync (const Model::GetGroupConfigurationRequest &request, const GetGroupConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetGroupQueryOutcome GetGroupQuery (const Model::GetGroupQueryRequest &request) const
 
virtual Model::GetGroupQueryOutcomeCallable GetGroupQueryCallable (const Model::GetGroupQueryRequest &request) const
 
virtual void GetGroupQueryAsync (const Model::GetGroupQueryRequest &request, const GetGroupQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetTagsOutcome GetTags (const Model::GetTagsRequest &request) const
 
virtual Model::GetTagsOutcomeCallable GetTagsCallable (const Model::GetTagsRequest &request) const
 
virtual void GetTagsAsync (const Model::GetTagsRequest &request, const GetTagsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GroupResourcesOutcome GroupResources (const Model::GroupResourcesRequest &request) const
 
virtual Model::GroupResourcesOutcomeCallable GroupResourcesCallable (const Model::GroupResourcesRequest &request) const
 
virtual void GroupResourcesAsync (const Model::GroupResourcesRequest &request, const GroupResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListGroupResourcesOutcome ListGroupResources (const Model::ListGroupResourcesRequest &request) const
 
virtual Model::ListGroupResourcesOutcomeCallable ListGroupResourcesCallable (const Model::ListGroupResourcesRequest &request) const
 
virtual void ListGroupResourcesAsync (const Model::ListGroupResourcesRequest &request, const ListGroupResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListGroupsOutcome ListGroups (const Model::ListGroupsRequest &request) const
 
virtual Model::ListGroupsOutcomeCallable ListGroupsCallable (const Model::ListGroupsRequest &request) const
 
virtual void ListGroupsAsync (const Model::ListGroupsRequest &request, const ListGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutGroupConfigurationOutcome PutGroupConfiguration (const Model::PutGroupConfigurationRequest &request) const
 
virtual Model::PutGroupConfigurationOutcomeCallable PutGroupConfigurationCallable (const Model::PutGroupConfigurationRequest &request) const
 
virtual void PutGroupConfigurationAsync (const Model::PutGroupConfigurationRequest &request, const PutGroupConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SearchResourcesOutcome SearchResources (const Model::SearchResourcesRequest &request) const
 
virtual Model::SearchResourcesOutcomeCallable SearchResourcesCallable (const Model::SearchResourcesRequest &request) const
 
virtual void SearchResourcesAsync (const Model::SearchResourcesRequest &request, const SearchResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagOutcome Tag (const Model::TagRequest &request) const
 
virtual Model::TagOutcomeCallable TagCallable (const Model::TagRequest &request) const
 
virtual void TagAsync (const Model::TagRequest &request, const TagResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UngroupResourcesOutcome UngroupResources (const Model::UngroupResourcesRequest &request) const
 
virtual Model::UngroupResourcesOutcomeCallable UngroupResourcesCallable (const Model::UngroupResourcesRequest &request) const
 
virtual void UngroupResourcesAsync (const Model::UngroupResourcesRequest &request, const UngroupResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagOutcome Untag (const Model::UntagRequest &request) const
 
virtual Model::UntagOutcomeCallable UntagCallable (const Model::UntagRequest &request) const
 
virtual void UntagAsync (const Model::UntagRequest &request, const UntagResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateGroupOutcome UpdateGroup (const Model::UpdateGroupRequest &request) const
 
virtual Model::UpdateGroupOutcomeCallable UpdateGroupCallable (const Model::UpdateGroupRequest &request) const
 
virtual void UpdateGroupAsync (const Model::UpdateGroupRequest &request, const UpdateGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateGroupQueryOutcome UpdateGroupQuery (const Model::UpdateGroupQueryRequest &request) const
 
virtual Model::UpdateGroupQueryOutcomeCallable UpdateGroupQueryCallable (const Model::UpdateGroupQueryRequest &request) const
 
virtual void UpdateGroupQueryAsync (const Model::UpdateGroupQueryRequest &request, const UpdateGroupQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

<fullname>AWS Resource Groups</fullname>

AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the AWS Resource Groups User Guide.

AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

Definition at line 166 of file ResourceGroupsClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 169 of file ResourceGroupsClient.h.

Constructor & Destructor Documentation

◆ ResourceGroupsClient() [1/3]

Aws::ResourceGroups::ResourceGroupsClient::ResourceGroupsClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ResourceGroupsClient() [2/3]

Aws::ResourceGroups::ResourceGroupsClient::ResourceGroupsClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ResourceGroupsClient() [3/3]

Aws::ResourceGroups::ResourceGroupsClient::ResourceGroupsClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~ResourceGroupsClient()

virtual Aws::ResourceGroups::ResourceGroupsClient::~ResourceGroupsClient ( )
virtual

Member Function Documentation

◆ CreateGroup()

virtual Model::CreateGroupOutcome Aws::ResourceGroups::ResourceGroupsClient::CreateGroup ( const Model::CreateGroupRequest request) const
virtual

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

See Also:

AWS API Reference

◆ CreateGroupAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::CreateGroupAsync ( const Model::CreateGroupRequest request,
const CreateGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateGroupCallable()

virtual Model::CreateGroupOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::CreateGroupCallable ( const Model::CreateGroupRequest request) const
virtual

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteGroup()

virtual Model::DeleteGroupOutcome Aws::ResourceGroups::ResourceGroupsClient::DeleteGroup ( const Model::DeleteGroupRequest request) const
virtual

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:DeleteGroup

See Also:


AWS API Reference

◆ DeleteGroupAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::DeleteGroupAsync ( const Model::DeleteGroupRequest request,
const DeleteGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:DeleteGroup

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteGroupCallable()

virtual Model::DeleteGroupOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::DeleteGroupCallable ( const Model::DeleteGroupRequest request) const
virtual

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:DeleteGroup

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetGroup()

virtual Model::GetGroupOutcome Aws::ResourceGroups::ResourceGroupsClient::GetGroup ( const Model::GetGroupRequest request) const
virtual

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

See Also:

AWS API Reference

◆ GetGroupAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::GetGroupAsync ( const Model::GetGroupRequest request,
const GetGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetGroupCallable()

virtual Model::GetGroupOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::GetGroupCallable ( const Model::GetGroupRequest request) const
virtual

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetGroupConfiguration()

virtual Model::GetGroupConfigurationOutcome Aws::ResourceGroups::ResourceGroupsClient::GetGroupConfiguration ( const Model::GetGroupConfigurationRequest request) const
virtual

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupConfiguration

See Also:

AWS API Reference

◆ GetGroupConfigurationAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::GetGroupConfigurationAsync ( const Model::GetGroupConfigurationRequest request,
const GetGroupConfigurationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupConfiguration

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetGroupConfigurationCallable()

virtual Model::GetGroupConfigurationOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::GetGroupConfigurationCallable ( const Model::GetGroupConfigurationRequest request) const
virtual

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupConfiguration

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetGroupQuery()

virtual Model::GetGroupQueryOutcome Aws::ResourceGroups::ResourceGroupsClient::GetGroupQuery ( const Model::GetGroupQueryRequest request) const
virtual

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupQuery

See Also:

AWS API Reference

◆ GetGroupQueryAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::GetGroupQueryAsync ( const Model::GetGroupQueryRequest request,
const GetGroupQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupQuery

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetGroupQueryCallable()

virtual Model::GetGroupQueryOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::GetGroupQueryCallable ( const Model::GetGroupQueryRequest request) const
virtual

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupQuery

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetTags()

virtual Model::GetTagsOutcome Aws::ResourceGroups::ResourceGroupsClient::GetTags ( const Model::GetTagsRequest request) const
virtual

Returns a list of tags that are associated with a resource group, specified by an ARN.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetTags

See Also:

AWS API Reference

◆ GetTagsAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::GetTagsAsync ( const Model::GetTagsRequest request,
const GetTagsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of tags that are associated with a resource group, specified by an ARN.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetTags

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetTagsCallable()

virtual Model::GetTagsOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::GetTagsCallable ( const Model::GetTagsRequest request) const
virtual

Returns a list of tags that are associated with a resource group, specified by an ARN.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetTags

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GroupResources()

virtual Model::GroupResourcesOutcome Aws::ResourceGroups::ResourceGroupsClient::GroupResources ( const Model::GroupResourcesRequest request) const
virtual

Adds the specified resources to the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

See Also:

AWS API Reference

◆ GroupResourcesAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::GroupResourcesAsync ( const Model::GroupResourcesRequest request,
const GroupResourcesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Adds the specified resources to the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GroupResourcesCallable()

virtual Model::GroupResourcesOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::GroupResourcesCallable ( const Model::GroupResourcesRequest request) const
virtual

Adds the specified resources to the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListGroupResources()

virtual Model::ListGroupResourcesOutcome Aws::ResourceGroups::ResourceGroupsClient::ListGroupResources ( const Model::ListGroupResourcesRequest request) const
virtual

Returns a list of ARNs of the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroupResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

◆ ListGroupResourcesAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::ListGroupResourcesAsync ( const Model::ListGroupResourcesRequest request,
const ListGroupResourcesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of ARNs of the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroupResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListGroupResourcesCallable()

virtual Model::ListGroupResourcesOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::ListGroupResourcesCallable ( const Model::ListGroupResourcesRequest request) const
virtual

Returns a list of ARNs of the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroupResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListGroups()

virtual Model::ListGroupsOutcome Aws::ResourceGroups::ResourceGroupsClient::ListGroups ( const Model::ListGroupsRequest request) const
virtual

Returns a list of existing resource groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

See Also:

AWS API Reference

◆ ListGroupsAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::ListGroupsAsync ( const Model::ListGroupsRequest request,
const ListGroupsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of existing resource groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListGroupsCallable()

virtual Model::ListGroupsOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::ListGroupsCallable ( const Model::ListGroupsRequest request) const
virtual

Returns a list of existing resource groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::ResourceGroups::ResourceGroupsClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PutGroupConfiguration()

virtual Model::PutGroupConfigurationOutcome Aws::ResourceGroups::ResourceGroupsClient::PutGroupConfiguration ( const Model::PutGroupConfigurationRequest request) const
virtual

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:PutGroupConfiguration

See Also:

AWS API Reference

◆ PutGroupConfigurationAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::PutGroupConfigurationAsync ( const Model::PutGroupConfigurationRequest request,
const PutGroupConfigurationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:PutGroupConfiguration

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutGroupConfigurationCallable()

virtual Model::PutGroupConfigurationOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::PutGroupConfigurationCallable ( const Model::PutGroupConfigurationRequest request) const
virtual

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:PutGroupConfiguration

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SearchResources()

virtual Model::SearchResourcesOutcome Aws::ResourceGroups::ResourceGroupsClient::SearchResources ( const Model::SearchResourcesRequest request) const
virtual

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:SearchResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

◆ SearchResourcesAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::SearchResourcesAsync ( const Model::SearchResourcesRequest request,
const SearchResourcesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:SearchResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SearchResourcesCallable()

virtual Model::SearchResourcesOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::SearchResourcesCallable ( const Model::SearchResourcesRequest request) const
virtual

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:SearchResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ Tag()

virtual Model::TagOutcome Aws::ResourceGroups::ResourceGroupsClient::Tag ( const Model::TagRequest request) const
virtual

Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Tag

See Also:

AWS API Reference

◆ TagAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::TagAsync ( const Model::TagRequest request,
const TagResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Tag

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagCallable()

virtual Model::TagOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::TagCallable ( const Model::TagRequest request) const
virtual

Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Tag

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UngroupResources()

virtual Model::UngroupResourcesOutcome Aws::ResourceGroups::ResourceGroupsClient::UngroupResources ( const Model::UngroupResourcesRequest request) const
virtual

Removes the specified resources from the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UngroupResources

See Also:

AWS API Reference

◆ UngroupResourcesAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::UngroupResourcesAsync ( const Model::UngroupResourcesRequest request,
const UngroupResourcesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes the specified resources from the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UngroupResources

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UngroupResourcesCallable()

virtual Model::UngroupResourcesOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::UngroupResourcesCallable ( const Model::UngroupResourcesRequest request) const
virtual

Removes the specified resources from the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UngroupResources

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ Untag()

virtual Model::UntagOutcome Aws::ResourceGroups::ResourceGroupsClient::Untag ( const Model::UntagRequest request) const
virtual

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Untag

See Also:

AWS API Reference

◆ UntagAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::UntagAsync ( const Model::UntagRequest request,
const UntagResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Untag

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagCallable()

virtual Model::UntagOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::UntagCallable ( const Model::UntagRequest request) const
virtual

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Untag

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateGroup()

virtual Model::UpdateGroupOutcome Aws::ResourceGroups::ResourceGroupsClient::UpdateGroup ( const Model::UpdateGroupRequest request) const
virtual

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

See Also:


AWS API Reference

◆ UpdateGroupAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::UpdateGroupAsync ( const Model::UpdateGroupRequest request,
const UpdateGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateGroupCallable()

virtual Model::UpdateGroupOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::UpdateGroupCallable ( const Model::UpdateGroupRequest request) const
virtual

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateGroupQuery()

virtual Model::UpdateGroupQueryOutcome Aws::ResourceGroups::ResourceGroupsClient::UpdateGroupQuery ( const Model::UpdateGroupQueryRequest request) const
virtual

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroupQuery

See Also:

AWS API Reference

◆ UpdateGroupQueryAsync()

virtual void Aws::ResourceGroups::ResourceGroupsClient::UpdateGroupQueryAsync ( const Model::UpdateGroupQueryRequest request,
const UpdateGroupQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroupQuery

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateGroupQueryCallable()

virtual Model::UpdateGroupQueryOutcomeCallable Aws::ResourceGroups::ResourceGroupsClient::UpdateGroupQueryCallable ( const Model::UpdateGroupQueryRequest request) const
virtual

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroupQuery

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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