Class: Aws::ResourceGroups::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-resourcegroups/client.rb

Overview

An API client for ResourceGroups. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::ResourceGroups::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ResourceGroups::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ResourceGroups::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



434
435
436
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 434

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1570
1571
1572
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1570

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1573
1574
1575
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1573

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1543

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ResourceGroups')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-resourcegroups'
  context[:gem_version] = '1.67.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_group(params = {}) ⇒ Types::CreateGroupOutput

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see [Build queries and groups in Resource Groups] in the *Resource Groups User Guide*. For more information about service-linked groups and service configurations, see [Service configurations for Resource Groups].

**Minimum permissions**

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

  • ‘resource-groups:CreateGroup`

^

[1]: docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html [2]: docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html

Examples:

Request syntax with placeholder values


resp = client.create_group({
  name: "GroupName", # required
  description: "Description",
  resource_query: {
    type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
    query: "Query", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  configuration: [
    {
      type: "GroupConfigurationType", # required
      parameters: [
        {
          name: "GroupConfigurationParameterName", # required
          values: ["GroupConfigurationParameterValue"],
        },
      ],
    },
  ],
})

Response structure


resp.group.group_arn #=> String
resp.group.name #=> String
resp.group.description #=> String
resp.resource_query.type #=> String, one of "TAG_FILTERS_1_0", "CLOUDFORMATION_STACK_1_0"
resp.resource_query.query #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.group_configuration.configuration #=> Array
resp.group_configuration.configuration[0].type #=> String
resp.group_configuration.configuration[0].parameters #=> Array
resp.group_configuration.configuration[0].parameters[0].name #=> String
resp.group_configuration.configuration[0].parameters[0].values #=> Array
resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
resp.group_configuration.proposed_configuration #=> Array
resp.group_configuration.proposed_configuration[0].type #=> String
resp.group_configuration.proposed_configuration[0].parameters #=> Array
resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.group_configuration.failure_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the group, which is the identifier of the group in other operations. You can’t change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with ‘AWS`, `aws`, or any other possible capitalization; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.

  • :description (String) —

    The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.

  • :resource_query (Types::ResourceQuery) —

    The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see [Create a tag-based group in Resource Groups].

    <note markdown=“1”> A resource group can contain either a ‘ResourceQuery` or a `Configuration`, but not both.

    </note>

    [1]: docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag

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

    The tags to add to the group. A tag is key-value pair string.

  • :configuration (Array<Types::GroupConfigurationItem>) —

    A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see [Service configurations for Resource Groups].

    <note markdown=“1”> A resource group can contain either a ‘Configuration` or a `ResourceQuery`, but not both.

    </note>

    [1]: docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html

Returns:

See Also:



568
569
570
571
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 568

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Types::DeleteGroupOutput

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`

^

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "GroupName",
  group: "GroupString",
})

Response structure


resp.group.group_arn #=> String
resp.group.name #=> String
resp.group.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Deprecated - don’t use this parameter. Use ‘Group` instead.

  • :group (String) —

    The name or the ARN of the resource group to delete.

Returns:

See Also:



612
613
614
615
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 612

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsOutput

Retrieves the current status of optional features in Resource Groups.

Examples:

Response structure


resp..group_lifecycle_events_desired_status #=> String, one of "ACTIVE", "INACTIVE"
resp..group_lifecycle_events_status #=> String, one of "ACTIVE", "INACTIVE", "IN_PROGRESS", "ERROR"
resp..group_lifecycle_events_status_message #=> String

Parameters:

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

    ({})

Returns:

See Also:



633
634
635
636
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 633

def (params = {}, options = {})
  req = build_request(:get_account_settings, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ Types::GetGroupOutput

Returns information about a specified resource group.

**Minimum permissions**

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

  • ‘resource-groups:GetGroup`

^

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_name: "GroupName",
  group: "GroupString",
})

Response structure


resp.group.group_arn #=> String
resp.group.name #=> String
resp.group.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Deprecated - don’t use this parameter. Use ‘Group` instead.

  • :group (String) —

    The name or the ARN of the resource group to retrieve.

Returns:

See Also:



675
676
677
678
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 675

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#get_group_configuration(params = {}) ⇒ Types::GetGroupConfigurationOutput

Retrieves 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`

^

[1]: docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html

Examples:

Request syntax with placeholder values


resp = client.get_group_configuration({
  group: "GroupString",
})

Response structure


resp.group_configuration.configuration #=> Array
resp.group_configuration.configuration[0].type #=> String
resp.group_configuration.configuration[0].parameters #=> Array
resp.group_configuration.configuration[0].parameters[0].name #=> String
resp.group_configuration.configuration[0].parameters[0].values #=> Array
resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
resp.group_configuration.proposed_configuration #=> Array
resp.group_configuration.proposed_configuration[0].type #=> String
resp.group_configuration.proposed_configuration[0].parameters #=> Array
resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.group_configuration.failure_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group (String) —

    The name or the ARN of the resource group for which you want to retrive the service configuration.

Returns:

See Also:



731
732
733
734
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 731

def get_group_configuration(params = {}, options = {})
  req = build_request(:get_group_configuration, params)
  req.send_request(options)
end

#get_group_query(params = {}) ⇒ Types::GetGroupQueryOutput

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`

^

[1]: docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag

Examples:

Request syntax with placeholder values


resp = client.get_group_query({
  group_name: "GroupName",
  group: "GroupString",
})

Response structure


resp.group_query.group_name #=> String
resp.group_query.resource_query.type #=> String, one of "TAG_FILTERS_1_0", "CLOUDFORMATION_STACK_1_0"
resp.group_query.resource_query.query #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Don’t use this parameter. Use ‘Group` instead.

  • :group (String) —

    The name or the ARN of the resource group to query.

Returns:

See Also:



779
780
781
782
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 779

def get_group_query(params = {}, options = {})
  req = build_request(:get_group_query, params)
  req.send_request(options)
end

#get_tags(params = {}) ⇒ Types::GetTagsOutput

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`

^

Examples:

Request syntax with placeholder values


resp = client.get_tags({
  arn: "GroupArn", # required
})

Response structure


resp.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the resource group whose tags you want to retrieve.

Returns:

  • (Types::GetTagsOutput) —

    Returns a response object which responds to the following methods:

    • #arn => String

    • #tags => Hash&lt;String,String&gt;

See Also:



819
820
821
822
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 819

def get_tags(params = {}, options = {})
  req = build_request(:get_tags, params)
  req.send_request(options)
end

#group_resources(params = {}) ⇒ Types::GroupResourcesOutput

Adds the specified resources to the specified group.

You can use this operation with only resource groups that are configured with the following types:

* `AWS::EC2::HostManagement`

  • ‘AWS::EC2::CapacityReservationPool`

Other resource group type and resource types aren't currently

supported by this operation.

**Minimum permissions**

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

  • ‘resource-groups:GroupResources`

^

Examples:

Request syntax with placeholder values


resp = client.group_resources({
  group: "GroupString", # required
  resource_arns: ["ResourceArn"], # required
})

Response structure


resp.succeeded #=> Array
resp.succeeded[0] #=> String
resp.failed #=> Array
resp.failed[0].resource_arn #=> String
resp.failed[0].error_message #=> String
resp.failed[0].error_code #=> String
resp.pending #=> Array
resp.pending[0].resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group (required, String) —

    The name or the ARN of the resource group to add resources to.

  • :resource_arns (required, Array<String>) —

    The list of ARNs of the resources to be added to the group.

Returns:

See Also:



878
879
880
881
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 878

def group_resources(params = {}, options = {})
  req = build_request(:group_resources, params)
  req.send_request(options)
end

#list_group_resources(params = {}) ⇒ Types::ListGroupResourcesOutput

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`

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_resources({
  group_name: "GroupName",
  group: "GroupString",
  filters: [
    {
      name: "resource-type", # required, accepts resource-type
      values: ["ResourceFilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.resources #=> Array
resp.resources[0].identifier.resource_arn #=> String
resp.resources[0].identifier.resource_type #=> String
resp.resources[0].status.name #=> String, one of "PENDING"
resp.resource_identifiers #=> Array
resp.resource_identifiers[0].resource_arn #=> String
resp.resource_identifiers[0].resource_type #=> String
resp.next_token #=> String
resp.query_errors #=> Array
resp.query_errors[0].error_code #=> String, one of "CLOUDFORMATION_STACK_INACTIVE", "CLOUDFORMATION_STACK_NOT_EXISTING", "CLOUDFORMATION_STACK_UNASSUMABLE_ROLE", "RESOURCE_TYPE_NOT_SUPPORTED"
resp.query_errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Deprecated - don’t use this parameter. Use the Group request field instead.

  • :group (String) —

    The name or the ARN of the resource group

  • :filters (Array<Types::ResourceFilter>) —

    Filters, formatted as ResourceFilter objects, that you want to apply to a ‘ListGroupResources` operation. Filters the results to include only those of the specified resource types.

    • ‘resource-type` - Filter resources by their type. Specify up to five resource types in the format `AWS::ServiceCode::ResourceType`. For example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.

    ^

    When you specify a ‘resource-type` filter for `ListGroupResources`, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your `resource-type` filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a `ListGroupResources` request returns a `BadRequestException` error with a message similar to the following:

    ‘The resource types specified as filters in the request are not valid.`

    The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn’t occur when the group query specifies ‘AWS::AllSupported`, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).

  • :max_results (Integer) —

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the ‘NextToken` response element is present and has a value (is not null). Include that value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

  • :next_token (String) —

    The parameter for receiving additional results if you receive a ‘NextToken` response in a previous request. A `NextToken` response indicates that more output is available. Set this parameter to the value provided by a previous call’s ‘NextToken` response to indicate where the output should continue from.

Returns:

See Also:



996
997
998
999
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 996

def list_group_resources(params = {}, options = {})
  req = build_request(:list_group_resources, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsOutput

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`

^

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  filters: [
    {
      name: "resource-type", # required, accepts resource-type, configuration-type
      values: ["GroupFilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.group_identifiers #=> Array
resp.group_identifiers[0].group_name #=> String
resp.group_identifiers[0].group_arn #=> String
resp.groups #=> Array
resp.groups[0].group_arn #=> String
resp.groups[0].name #=> String
resp.groups[0].description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::GroupFilter>) —

    Filters, formatted as GroupFilter objects, that you want to apply to a ‘ListGroups` operation.

    • ‘resource-type` - Filter the results to include only those resource groups that have the specified resource type in their `ResourceTypeFilter`. For example, `AWS::EC2::Instance` would return any resource group with a `ResourceTypeFilter` that includes `AWS::EC2::Instance`.

    • ‘configuration-type` - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

      • ‘AWS::AppRegistry::Application`

      • ‘AWS::AppRegistry::ApplicationResourceGroups`

      • ‘AWS::CloudFormation::Stack`

      • ‘AWS::EC2::CapacityReservationPool`

      • ‘AWS::EC2::HostManagement`

      • ‘AWS::NetworkFirewall::RuleGroup`

  • :max_results (Integer) —

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the ‘NextToken` response element is present and has a value (is not null). Include that value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

  • :next_token (String) —

    The parameter for receiving additional results if you receive a ‘NextToken` response in a previous request. A `NextToken` response indicates that more output is available. Set this parameter to the value provided by a previous call’s ‘NextToken` response to indicate where the output should continue from.

Returns:

See Also:



1092
1093
1094
1095
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1092

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#put_group_configuration(params = {}) ⇒ Struct

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`

^

Examples:

Request syntax with placeholder values


resp = client.put_group_configuration({
  group: "GroupString",
  configuration: [
    {
      type: "GroupConfigurationType", # required
      parameters: [
        {
          name: "GroupConfigurationParameterName", # required
          values: ["GroupConfigurationParameterValue"],
        },
      ],
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :group (String) —

    The name or ARN of the resource group with the configuration that you want to update.

  • :configuration (Array<Types::GroupConfigurationItem>) —

    The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.

    For information about the syntax of a service configuration, see [Service configurations for Resource Groups].

    <note markdown=“1”> A resource group can contain either a ‘Configuration` or a `ResourceQuery`, but not both.

    </note>

    [1]: docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1155
1156
1157
1158
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1155

def put_group_configuration(params = {}, options = {})
  req = build_request(:put_group_configuration, params)
  req.send_request(options)
end

#search_resources(params = {}) ⇒ Types::SearchResourcesOutput

Returns a list of Amazon Web Services 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`

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_resources({
  resource_query: { # required
    type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
    query: "Query", # required
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.resource_identifiers #=> Array
resp.resource_identifiers[0].resource_arn #=> String
resp.resource_identifiers[0].resource_type #=> String
resp.next_token #=> String
resp.query_errors #=> Array
resp.query_errors[0].error_code #=> String, one of "CLOUDFORMATION_STACK_INACTIVE", "CLOUDFORMATION_STACK_NOT_EXISTING", "CLOUDFORMATION_STACK_UNASSUMABLE_ROLE", "RESOURCE_TYPE_NOT_SUPPORTED"
resp.query_errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_query (required, Types::ResourceQuery) —

    The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

  • :max_results (Integer) —

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the ‘NextToken` response element is present and has a value (is not null). Include that value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

  • :next_token (String) —

    The parameter for receiving additional results if you receive a ‘NextToken` response in a previous request. A `NextToken` response indicates that more output is available. Set this parameter to the value provided by a previous call’s ‘NextToken` response to indicate where the output should continue from.

Returns:

See Also:



1232
1233
1234
1235
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1232

def search_resources(params = {}, options = {})
  req = build_request(:search_resources, params)
  req.send_request(options)
end

#tag(params = {}) ⇒ Types::TagOutput

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`

^

Examples:

Request syntax with placeholder values


resp = client.tag({
  arn: "GroupArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the resource group to which to add tags.

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

    The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs.

Returns:

  • (Types::TagOutput) —

    Returns a response object which responds to the following methods:

    • #arn => String

    • #tags => Hash&lt;String,String&gt;

See Also:



1285
1286
1287
1288
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1285

def tag(params = {}, options = {})
  req = build_request(:tag, params)
  req.send_request(options)
end

#ungroup_resources(params = {}) ⇒ Types::UngroupResourcesOutput

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn’t work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.

**Minimum permissions**

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

  • ‘resource-groups:UngroupResources`

^

Examples:

Request syntax with placeholder values


resp = client.ungroup_resources({
  group: "GroupString", # required
  resource_arns: ["ResourceArn"], # required
})

Response structure


resp.succeeded #=> Array
resp.succeeded[0] #=> String
resp.failed #=> Array
resp.failed[0].resource_arn #=> String
resp.failed[0].error_message #=> String
resp.failed[0].error_code #=> String
resp.pending #=> Array
resp.pending[0].resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group (required, String) —

    The name or the ARN of the resource group from which to remove the resources.

  • :resource_arns (required, Array<String>) —

    The ARNs of the resources to be removed from the group.

Returns:

See Also:



1339
1340
1341
1342
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1339

def ungroup_resources(params = {}, options = {})
  req = build_request(:ungroup_resources, params)
  req.send_request(options)
end

#untag(params = {}) ⇒ Types::UntagOutput

Deletes tags from a specified resource group.

**Minimum permissions**

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

  • ‘resource-groups:Untag`

^

Examples:

Request syntax with placeholder values


resp = client.untag({
  arn: "GroupArn", # required
  keys: ["TagKey"], # required
})

Response structure


resp.arn #=> String
resp.keys #=> Array
resp.keys[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.

  • :keys (required, Array<String>) —

    The keys of the tags to be removed.

Returns:

  • (Types::UntagOutput) —

    Returns a response object which responds to the following methods:

    • #arn => String

    • #keys => Array&lt;String&gt;

See Also:



1384
1385
1386
1387
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1384

def untag(params = {}, options = {})
  req = build_request(:untag, params)
  req.send_request(options)
end

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsOutput

Turns on or turns off optional features in Resource Groups.

The preceding example shows that the request to turn on group lifecycle events is ‘IN_PROGRESS`. You can call the GetAccountSettings operation to check for completion by looking for `GroupLifecycleEventsStatus` to change to `ACTIVE`.

Examples:

Request syntax with placeholder values


resp = client.({
  group_lifecycle_events_desired_status: "ACTIVE", # accepts ACTIVE, INACTIVE
})

Response structure


resp..group_lifecycle_events_desired_status #=> String, one of "ACTIVE", "INACTIVE"
resp..group_lifecycle_events_status #=> String, one of "ACTIVE", "INACTIVE", "IN_PROGRESS", "ERROR"
resp..group_lifecycle_events_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1424
1425
1426
1427
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1424

def (params = {}, options = {})
  req = build_request(:update_account_settings, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ Types::UpdateGroupOutput

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`

^

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_name: "GroupName",
  group: "GroupString",
  description: "Description",
})

Response structure


resp.group.group_arn #=> String
resp.group.name #=> String
resp.group.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Don’t use this parameter. Use ‘Group` instead.

  • :group (String) —

    The name or the ARN of the resource group to modify.

  • :description (String) —

    The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

Returns:

See Also:



1473
1474
1475
1476
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1473

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_group_query(params = {}) ⇒ Types::UpdateGroupQueryOutput

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`

^

[1]: docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag

Examples:

Request syntax with placeholder values


resp = client.update_group_query({
  group_name: "GroupName",
  group: "GroupString",
  resource_query: { # required
    type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
    query: "Query", # required
  },
})

Response structure


resp.group_query.group_name #=> String
resp.group_query.resource_query.type #=> String, one of "TAG_FILTERS_1_0", "CLOUDFORMATION_STACK_1_0"
resp.group_query.resource_query.query #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (String) —

    Don’t use this parameter. Use ‘Group` instead.

  • :group (String) —

    The name or the ARN of the resource group to query.

  • :resource_query (required, Types::ResourceQuery) —

    The resource query to determine which Amazon Web Services resources are members of this resource group.

    <note markdown=“1”> A resource group can contain either a ‘Configuration` or a `ResourceQuery`, but not both.

    </note>

Returns:

See Also:



1534
1535
1536
1537
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1534

def update_group_query(params = {}, options = {})
  req = build_request(:update_group_query, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1563
1564
1565
 
# File 'lib/aws-sdk-resourcegroups/client.rb', line 1563

def waiter_names
  []
end