AbstractAWSResourceGroups (AWS Java SDK for AWS Resource Groups 1.12.782 API)

java.lang.Object
- com.amazonaws.services.resourcegroups.AbstractAWSResourceGroups

All Implemented Interfaces:

AWSResourceGroups

Direct Known Subclasses:

AbstractAWSResourceGroupsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSResourceGroups
extends Object
implements AWSResourceGroups
```
Abstract implementation of AWSResourceGroups. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.resourcegroups.AWSResourceGroups
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSResourceGroups()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSResourceGroups()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates a resource group with the specified name and description.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes the specified resource group.
`GetAccountSettingsResult`	`getAccountSettings(GetAccountSettingsRequest request)` Retrieves the current status of optional features in Resource Groups.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetGroupResult`	`getGroup(GetGroupRequest request)` Returns information about a specified resource group.
`GetGroupConfigurationResult`	`getGroupConfiguration(GetGroupConfigurationRequest request)` Retrieves the service configuration associated with the specified resource group.
`GetGroupQueryResult`	`getGroupQuery(GetGroupQueryRequest request)` Retrieves the resource query associated with the specified resource group.
`GetTagsResult`	`getTags(GetTagsRequest request)` Returns a list of tags that are associated with a resource group, specified by an ARN.
`GroupResourcesResult`	`groupResources(GroupResourcesRequest request)` Adds the specified resources to the specified group.
`ListGroupResourcesResult`	`listGroupResources(ListGroupResourcesRequest request)` Returns a list of ARNs of the resources that are members of a specified resource group.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Returns a list of existing Resource Groups in your account.
`PutGroupConfigurationResult`	`putGroupConfiguration(PutGroupConfigurationRequest request)` Attaches a service configuration to the specified group.
`SearchResourcesResult`	`searchResources(SearchResourcesRequest request)` Returns a list of Amazon Web Services resource identifiers that matches the specified query.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResult`	`tag(TagRequest request)` Adds tags to a resource group with the specified ARN.
`UngroupResourcesResult`	`ungroupResources(UngroupResourcesRequest request)` Removes the specified resources from the specified group.
`UntagResult`	`untag(UntagRequest request)` Deletes tags from a specified resource group.
`UpdateAccountSettingsResult`	`updateAccountSettings(UpdateAccountSettingsRequest request)` Turns on or turns off optional features in Resource Groups.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest request)` Updates the description for an existing group.
`UpdateGroupQueryResult`	`updateGroupQuery(UpdateGroupQueryRequest request)` Updates the resource query of a group.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSResourceGroups
```
protected AbstractAWSResourceGroups()
```
- Method Detail
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    createGroup in interface AWSResourceGroups
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    deleteGroup in interface AWSResourceGroups
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
```
    Description copied from interface: AWSResourceGroups
    
    Retrieves the current status of optional features in Resource Groups.
    
    Specified by:
    
    getAccountSettings in interface AWSResourceGroups
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
public GetGroupResult getGroup(GetGroupRequest request)
```
    Description copied from interface: AWSResourceGroups
    Returns information about a specified resource group.
    
    Minimum permissions
    
    To run this command, you must have the following permissions:
    - resource-groups:GetGroup
    Specified by:
    
    getGroup in interface AWSResourceGroups
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGroupConfiguration
```
public GetGroupConfigurationResult getGroupConfiguration(GetGroupConfigurationRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    getGroupConfiguration in interface AWSResourceGroups
    
    Returns:
    
    Result of the GetGroupConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGroupQuery
```
public GetGroupQueryResult getGroupQuery(GetGroupQueryRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    getGroupQuery in interface AWSResourceGroups
    
    Returns:
    
    Result of the GetGroupQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTags
```
public GetTagsResult getTags(GetTagsRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    getTags in interface AWSResourceGroups
    
    Returns:
    
    Result of the GetTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - groupResources
```
public GroupResourcesResult groupResources(GroupResourcesRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    groupResources in interface AWSResourceGroups
    
    Returns:
    
    Result of the GroupResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroupResources
```
public ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    listGroupResources in interface AWSResourceGroups
    
    Returns:
    
    Result of the ListGroupResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    listGroups in interface AWSResourceGroups
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putGroupConfiguration
```
public PutGroupConfigurationResult putGroupConfiguration(PutGroupConfigurationRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    putGroupConfiguration in interface AWSResourceGroups
    
    Returns:
    
    Result of the PutGroupConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchResources
```
public SearchResourcesResult searchResources(SearchResourcesRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    searchResources in interface AWSResourceGroups
    
    Returns:
    
    Result of the SearchResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tag
```
public TagResult tag(TagRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    tag in interface AWSResourceGroups
    
    Returns:
    
    Result of the Tag operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - ungroupResources
```
public UngroupResourcesResult ungroupResources(UngroupResourcesRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    ungroupResources in interface AWSResourceGroups
    
    Returns:
    
    Result of the UngroupResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untag
```
public UntagResult untag(UntagRequest request)
```
    Description copied from interface: AWSResourceGroups
    Deletes tags from a specified resource group.
    
    Minimum permissions
    
    To run this command, you must have the following permissions:
    - resource-groups:Untag
    Specified by:
    
    untag in interface AWSResourceGroups
    
    Returns:
    
    Result of the Untag operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccountSettings
```
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
```
    Description copied from interface: AWSResourceGroups
    
    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.
    
    Specified by:
    
    updateAccountSettings in interface AWSResourceGroups
    
    Returns:
    
    Result of the UpdateAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    updateGroup in interface AWSResourceGroups
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGroupQuery
```
public UpdateGroupQueryResult updateGroupQuery(UpdateGroupQueryRequest request)
```
    Description copied from interface: AWSResourceGroups
    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
    Specified by:
    
    updateGroupQuery in interface AWSResourceGroups
    
    Returns:
    
    Result of the UpdateGroupQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSResourceGroups
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSResourceGroups
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSResourceGroups
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSResourceGroups
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAWSResourceGroups

Field Summary

Fields inherited from interface com.amazonaws.services.resourcegroups.AWSResourceGroups

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSResourceGroups

Method Detail

createGroup

deleteGroup

getAccountSettings

getGroup

getGroupConfiguration

getGroupQuery

getTags

groupResources

listGroupResources

listGroups

putGroupConfiguration

searchResources

tag

ungroupResources

untag

updateAccountSettings

updateGroup

updateGroupQuery

shutdown

getCachedResponseMetadata