ResourceGroupsTaggingAPIClient Class
(QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIClient)The ResourceGroupsTaggingAPIClient class provides access to the AWS Resource Groups Tagging API service. More...
| Header: | #include <ResourceGroupsTaggingAPIClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| ResourceGroupsTaggingAPIClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| ResourceGroupsTaggingAPIClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| GetResourcesResponse * | getResources(const GetResourcesRequest &request) |
| GetTagKeysResponse * | getTagKeys(const GetTagKeysRequest &request) |
| GetTagValuesResponse * | getTagValues(const GetTagValuesRequest &request) |
| TagResourcesResponse * | tagResources(const TagResourcesRequest &request) |
| UntagResourcesResponse * | untagResources(const UntagResourcesRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The ResourceGroupsTaggingAPIClient class provides access to the AWS Resource Groups Tagging API service.
<fullname>Resource Groups Tagging API</fullname>
This guide describes the API operations for the resource groups
tagging>
A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of "Stack" might be "Testing" for one and "Production" for the
other>
Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html">Working with Tag Editor</a> and <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/resource-groups.html">Working with Resource Groups</a>. For more information about permissions you need to use the resource groups tagging APIs, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-resource-groups.html">Obtaining Permissions for Resource Groups </a> and <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging
</a>>
You can use the resource groups tagging APIs to complete the following
tasks> <ul> <li>
Tag and untag supported resources located in the specified region for the AWS
accoun> </li> <li>
Use tag-based filters to search for resources located in the specified region for the AWS
accoun> </li> <li>
List all existing tag keys in the specified region for the AWS
accoun> </li> <li>
List all existing values for the specified key in the specified region for the AWS
accoun> </li> </ul>
Not all resources can have tags. For a lists of resources that you can tag, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/supported-resources.html">Supported Resources</a> in the <i>AWS Resource Groups and Tag Editor User
Guide</i>>
To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups and Tag Editor User
Member Function Documentation
ResourceGroupsTaggingAPIClient::ResourceGroupsTaggingAPIClient(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 ResourceGroupsTaggingAPIClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
ResourceGroupsTaggingAPIClient::ResourceGroupsTaggingAPIClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads ResourceGroupsTaggingAPIClient().
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] GetResourcesResponse *ResourceGroupsTaggingAPIClient::getResources(const GetResourcesRequest &request)
Sends request to the ResourceGroupsTaggingAPIClient service, and returns a pointer to an GetResourcesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as <i>filters</i>. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated
[slot] GetTagKeysResponse *ResourceGroupsTaggingAPIClient::getTagKeys(const GetTagKeysRequest &request)
Sends request to the ResourceGroupsTaggingAPIClient service, and returns a pointer to an GetTagKeysResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns all tag keys in the specified region for the AWS
[slot] GetTagValuesResponse *ResourceGroupsTaggingAPIClient::getTagValues(const GetTagValuesRequest &request)
Sends request to the ResourceGroupsTaggingAPIClient service, and returns a pointer to an GetTagValuesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns all tag values for the specified key in the specified region for the AWS
[slot] TagResourcesResponse *ResourceGroupsTaggingAPIClient::tagResources(const TagResourcesRequest &request)
Sends request to the ResourceGroupsTaggingAPIClient service, and returns a pointer to an TagResourcesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Applies one or more tags to the specified resources. Note the
following> <ul> <li>
Not all resources can have tags. For a list of resources that support tagging, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/supported-resources.html">Supported Resources</a> in the <i>AWS Resource Groups and Tag Editor User
Guide</i>> </li> <li>
Each resource can have up to 50 tags. For other limits, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions">Tag Restrictions</a> in the <i>Amazon EC2 User Guide for Linux
Instances</i>> </li> <li>
You can only tag resources that are located in the specified region for the AWS
account> </li> <li>
To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups and Tag Editor User
[slot] UntagResourcesResponse *ResourceGroupsTaggingAPIClient::untagResources(const UntagResourcesRequest &request)
Sends request to the ResourceGroupsTaggingAPIClient service, and returns a pointer to an UntagResourcesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the
following> <ul> <li>
To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups and Tag Editor User
Guide</i>> </li> <li>
You can only tag resources that are located in the specified region for the AWS
© 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.