You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ResourceGroupsTaggingAPI::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Resource Groups Tagging API. To construct a client, you need to configure a :region and :credentials.

resourcegroupstaggingapi = Aws::ResourceGroupsTaggingAPI::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ResourceGroupsTaggingAPI::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ResourceGroupsTaggingAPI::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#describe_report_creation(options = {}) ⇒ Types::DescribeReportCreationOutput

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Examples:

Request syntax with placeholder values


resp = client.describe_report_creation()

Response structure


resp.status #=> String
resp.s3_location #=> String
resp.error_message #=> String

Returns:

See Also:

#get_compliance_summary(options = {}) ⇒ 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 master account and from the us-east-1 Region.

Examples:

Request syntax with placeholder values


resp = client.get_compliance_summary({
  target_id_filters: ["TargetId"],
  region_filters: ["Region"],
  resource_type_filters: ["AmazonResourceType"],
  tag_key_filters: ["TagKey"],
  group_by: ["TARGET_ID"], # accepts TARGET_ID, REGION, RESOURCE_TYPE
  max_results: 1,
  pagination_token: "PaginationToken",
})

Response structure


resp.summary_list #=> Array
resp.summary_list[0].last_updated #=> String
resp.summary_list[0].target_id #=> String
resp.summary_list[0].target_id_type #=> String, one of "ACCOUNT", "OU", "ROOT"
resp.summary_list[0].region #=> String
resp.summary_list[0].resource_type #=> String
resp.summary_list[0].non_compliant_resources #=> Integer
resp.pagination_token #=> String

Options Hash (options):

  • :target_id_filters (Array<String>)

    The target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

  • :region_filters (Array<String>)

    A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

  • :resource_type_filters (Array<String>)

    The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource\'s Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

  • :tag_key_filters (Array<String>)

    A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

  • :group_by (Array<String>)

    A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

  • :max_results (Integer)

    A limit that restricts the number of results that are returned per page.

  • :pagination_token (String)

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Returns:

See Also:

#get_resources(options = {}) ⇒ 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.

You can check the PaginationToken response parameter to determine if a query is complete. Queries occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

Examples:

Request syntax with placeholder values


resp = client.get_resources({
  pagination_token: "PaginationToken",
  tag_filters: [
    {
      key: "TagKey",
      values: ["TagValue"],
    },
  ],
  resources_per_page: 1,
  tags_per_page: 1,
  resource_type_filters: ["AmazonResourceType"],
  include_compliance_details: false,
  exclude_compliant_resources: false,
})

Response structure


resp.pagination_token #=> String
resp.resource_tag_mapping_list #=> Array
resp.resource_tag_mapping_list[0].resource_arn #=> String
resp.resource_tag_mapping_list[0].tags #=> Array
resp.resource_tag_mapping_list[0].tags[0].key #=> String
resp.resource_tag_mapping_list[0].tags[0].value #=> String
resp.resource_tag_mapping_list[0].compliance_details.noncompliant_keys #=> Array
resp.resource_tag_mapping_list[0].compliance_details.noncompliant_keys[0] #=> String
resp.resource_tag_mapping_list[0].compliance_details.keys_with_noncompliant_values #=> Array
resp.resource_tag_mapping_list[0].compliance_details.keys_with_noncompliant_values[0] #=> String
resp.resource_tag_mapping_list[0].compliance_details.compliance_status #=> true/false

Options Hash (options):

  • :pagination_token (String)

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

  • :tag_filters (Array<Types::TagFilter>)

    A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

    Note the following when deciding how to use TagFilters:

    • If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

    • If you don\'t specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don\'t have associated tags are shown with an empty tag set, like this: "Tags": [].

    • If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

    • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

    • If you don\'t specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

      For example, for filters: filter1 = `{value1}`, filter2 = `{value2,value3,value4}` , filter3 = `key3`:

      • GetResources( `filter1` ) returns resources tagged with key1=value1

      • GetResources( `filter2` ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

      • GetResources( `filter3` ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

      • GetResources( `filter1,filter2,filter3` ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

  • :resources_per_page (Integer)

    A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

  • :tags_per_page (Integer)

    AWS recommends using ResourcesPerPage instead of this parameter.

    A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

    GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

    You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

  • :resource_type_filters (Array<String>)

    The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource\'s Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

  • :include_compliance_details (Boolean)

    Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

  • :exclude_compliant_resources (Boolean)

    Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

    You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Returns:

See Also:

#get_tag_keys(options = {}) ⇒ Types::GetTagKeysOutput

Returns all tag keys in the specified Region for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_tag_keys({
  pagination_token: "PaginationToken",
})

Response structure


resp.pagination_token #=> String
resp.tag_keys #=> Array
resp.tag_keys[0] #=> String

Options Hash (options):

  • :pagination_token (String)

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Returns:

See Also:

#get_tag_values(options = {}) ⇒ Types::GetTagValuesOutput

Returns all tag values for the specified key in the specified Region for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_tag_values({
  pagination_token: "PaginationToken",
  key: "TagKey", # required
})

Response structure


resp.pagination_token #=> String
resp.tag_values #=> Array
resp.tag_values[0] #=> String

Options Hash (options):

  • :pagination_token (String)

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

  • :key (required, String)

    The key for which you want to list all existing values in the specified Region for the AWS account.

Returns:

See Also:

#start_report_creation(options = {}) ⇒ Struct

Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily.

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 master account and from the us-east-1 Region.

Examples:

Request syntax with placeholder values


resp = client.start_report_creation({
  s3_bucket: "S3Bucket", # required
})

Options Hash (options):

  • :s3_bucket (required, String)

    The name of the Amazon S3 bucket where the report will be stored; for example:

    awsexamplebucket

    For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#tag_resources(options = {}) ⇒ 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 that support tagging, see this list.

  • 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 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 this list.

Examples:

Request syntax with placeholder values


resp = client.tag_resources({
  resource_arn_list: ["ResourceARN"], # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Response structure


resp.failed_resources_map #=> Hash
resp.failed_resources_map["ResourceARN"].status_code #=> Integer
resp.failed_resources_map["ResourceARN"].error_code #=> String, one of "InternalServiceException", "InvalidParameterException"
resp.failed_resources_map["ResourceARN"].error_message #=> String

Options Hash (options):

  • :resource_arn_list (required, Array<String>)

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

  • :tags (required, Hash<String,String>)

    The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Returns:

See Also:

#untag_resources(options = {}) ⇒ 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 this list.

  • You can only tag resources that are located in the specified Region for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.untag_resources({
  resource_arn_list: ["ResourceARN"], # required
  tag_keys: ["TagKey"], # required
})

Response structure


resp.failed_resources_map #=> Hash
resp.failed_resources_map["ResourceARN"].status_code #=> Integer
resp.failed_resources_map["ResourceARN"].error_code #=> String, one of "InternalServiceException", "InvalidParameterException"
resp.failed_resources_map["ResourceARN"].error_message #=> String

Options Hash (options):

  • :resource_arn_list (required, Array<String>)

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

  • :tag_keys (required, Array<String>)

    A list of the tag keys that you want to remove from the specified resources.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.