Class: Aws::ResourceGroupsTaggingAPI::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ResourceGroupsTaggingAPI::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb
Overview
An API client for ResourceGroupsTaggingAPI. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ResourceGroupsTaggingAPI::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#describe_report_creation(params = {}) ⇒ Types::DescribeReportCreationOutput
Describes the status of the
StartReportCreation
operation. -
#get_compliance_summary(params = {}) ⇒ Types::GetComplianceSummaryOutput
Returns a table that shows counts of resources that are noncompliant with their tag policies.
-
#get_resources(params = {}) ⇒ Types::GetResourcesOutput
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
-
#get_tag_keys(params = {}) ⇒ Types::GetTagKeysOutput
Returns all tag keys currently in use in the specified Region for the calling AWS account.
-
#get_tag_values(params = {}) ⇒ Types::GetTagValuesOutput
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
-
#start_report_creation(params = {}) ⇒ Struct
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy.
-
#tag_resources(params = {}) ⇒ Types::TagResourcesOutput
Applies one or more tags to the specified resources.
-
#untag_resources(params = {}) ⇒ Types::UntagResourcesOutput
Removes the specified tags from the specified resources.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#describe_report_creation(params = {}) ⇒ Types::DescribeReportCreationOutput
Describes the status of the StartReportCreation
operation.
You can call this operation only from the organization's management account and from the us-east-1 Region.
361 362 363 364 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 361 def describe_report_creation(params = {}, = {}) req = build_request(:describe_report_creation, params) req.send_request() end |
#get_compliance_summary(params = {}) ⇒ Types::GetComplianceSummaryOutput
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This operation supports pagination, where the response can be sent in
multiple pages. You should check the PaginationToken
response
parameter to determine if there are additional results available to
return. Repeat the query, passing the PaginationToken
response
parameter value as an input to the next request until you recieve a
null
value. A null value for PaginationToken
indicates that there
are no more results waiting to be returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
483 484 485 486 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 483 def get_compliance_summary(params = {}, = {}) req = build_request(:get_compliance_summary, params) req.send_request() end |
#get_resources(params = {}) ⇒ Types::GetResourcesOutput
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in
multiple pages. You should check the PaginationToken
response
parameter to determine if there are additional results available to
return. Repeat the query, passing the PaginationToken
response
parameter value as an input to the next request until you recieve a
null
value. A null value for PaginationToken
indicates that there
are no more results waiting to be returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
684 685 686 687 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 684 def get_resources(params = {}, = {}) req = build_request(:get_resources, params) req.send_request() end |
#get_tag_keys(params = {}) ⇒ Types::GetTagKeysOutput
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in
multiple pages. You should check the PaginationToken
response
parameter to determine if there are additional results available to
return. Repeat the query, passing the PaginationToken
response
parameter value as an input to the next request until you recieve a
null
value. A null value for PaginationToken
indicates that there
are no more results waiting to be returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
728 729 730 731 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 728 def get_tag_keys(params = {}, = {}) req = build_request(:get_tag_keys, params) req.send_request() end |
#get_tag_values(params = {}) ⇒ Types::GetTagValuesOutput
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
This operation supports pagination, where the response can be sent in
multiple pages. You should check the PaginationToken
response
parameter to determine if there are additional results available to
return. Repeat the query, passing the PaginationToken
response
parameter value as an input to the next request until you recieve a
null
value. A null value for PaginationToken
indicates that there
are no more results waiting to be returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
778 779 780 781 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 778 def get_tag_values(params = {}, = {}) req = build_request(:get_tag_values, params) req.send_request() end |
#start_report_creation(params = {}) ⇒ Struct
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.
The generated report is saved to the following location:
s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv
You can call this operation only from the organization's management account and from the us-east-1 Region.
816 817 818 819 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 816 def start_report_creation(params = {}, = {}) req = build_request(:start_report_creation, params) req.send_request() end |
#tag_resources(params = {}) ⇒ Types::TagResourcesOutput
Applies one or more tags to the specified resources. Note the following:
Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.
You can only tag resources that are located in the specified AWS Region for the AWS account.
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 the documentation for each service.
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.
889 890 891 892 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 889 def tag_resources(params = {}, = {}) req = build_request(:tag_resources, params) req.send_request() end |
#untag_resources(params = {}) ⇒ Types::UntagResourcesOutput
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:
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 the documentation for the service whose resource you want to untag.
You can only tag resources that are located in the specified AWS Region for the calling AWS account.
945 946 947 948 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 945 def untag_resources(params = {}, = {}) req = build_request(:untag_resources, params) req.send_request() end |