Contents

ResourceGroupsClient Class

(QtAws::ResourceGroups::ResourceGroupsClient)

The ResourceGroupsClient class provides access to the AWS Resource Groups service. More...

Header: #include <ResourceGroupsClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

ResourceGroupsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
ResourceGroupsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

CreateGroupResponse *createGroup(const CreateGroupRequest &request)
DeleteGroupResponse *deleteGroup(const DeleteGroupRequest &request)
GetGroupResponse *getGroup(const GetGroupRequest &request)
GetGroupQueryResponse *getGroupQuery(const GetGroupQueryRequest &request)
GetTagsResponse *getTags(const GetTagsRequest &request)
ListGroupResourcesResponse *listGroupResources(const ListGroupResourcesRequest &request)
ListGroupsResponse *listGroups(const ListGroupsRequest &request)
SearchResourcesResponse *searchResources(const SearchResourcesRequest &request)
TagResponse *tag(const TagRequest &request)
UntagResponse *untag(const UntagRequest &request)
UpdateGroupResponse *updateGroup(const UpdateGroupRequest &request)
UpdateGroupQueryResponse *updateGroupQuery(const UpdateGroupQueryRequest &request)

Additional Inherited Members

Detailed Description

The ResourceGroupsClient class provides access to the AWS Resource Groups service.

<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 <a href="https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html">AWS Resource Groups User

Guide</a>>

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

operations> <ul> <li>

Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query

entitie> </li> <li>

Applying, editing, and removing tags from resource

group> </li> <li>

Resolving resource group member ARNs so they can be returned as search

result> </li> <li>

Getting data about resources that are members of a

grou> </li> <li>

Searching AWS resources based on a resource

Member Function Documentation

ResourceGroupsClient::ResourceGroupsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ResourceGroupsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ResourceGroupsClient::ResourceGroupsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ResourceGroupsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateGroupResponse *ResourceGroupsClient::createGroup(const CreateGroupRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an CreateGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a group with a specified name, description, and resource

[slot] DeleteGroupResponse *ResourceGroupsClient::deleteGroup(const DeleteGroupRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an DeleteGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetGroupResponse *ResourceGroupsClient::getGroup(const GetGroupRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an GetGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a specified resource

[slot] GetGroupQueryResponse *ResourceGroupsClient::getGroupQuery(const GetGroupQueryRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an GetGroupQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the resource query associated with the specified resource

[slot] GetTagsResponse *ResourceGroupsClient::getTags(const GetTagsRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an GetTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListGroupResourcesResponse *ResourceGroupsClient::listGroupResources(const ListGroupResourcesRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an ListGroupResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of ARNs of resources that are members of a specified resource

[slot] ListGroupsResponse *ResourceGroupsClient::listGroups(const ListGroupsRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an ListGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of existing resource groups in your

[slot] SearchResourcesResponse *ResourceGroupsClient::searchResources(const SearchResourcesRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an SearchResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] TagResponse *ResourceGroupsClient::tag(const TagRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an TagResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UntagResponse *ResourceGroupsClient::untag(const UntagRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an UntagResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes specified tags from a specified

[slot] UpdateGroupResponse *ResourceGroupsClient::updateGroup(const UpdateGroupRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an UpdateGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an existing group with a new or changed description. You cannot update the name of a resource

[slot] UpdateGroupQueryResponse *ResourceGroupsClient::updateGroupQuery(const UpdateGroupQueryRequest &request)

Sends request to the ResourceGroupsClient service, and returns a pointer to an UpdateGroupQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the resource query of a

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.