Interface ResourceGroupsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ResourceGroupsAsyncClient extends AwsClient
Service client for accessing Resource Groups asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the Resource Groups User Guide.

Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

  • Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

  • Applying, editing, and removing tags from resource groups

  • Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results

  • Getting data about resources that are members of a group

  • Searching Amazon Web Services resources based on a resource query

  • Field Details

  • Method Details

    • cancelTagSyncTask

      default CompletableFuture<CancelTagSyncTaskResponse> cancelTagSyncTask(CancelTagSyncTaskRequest cancelTagSyncTaskRequest)

      Cancels the specified tag-sync task.

      Minimum permissions

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

      • resource-groups:CancelTagSyncTask on the application group

      • resource-groups:DeleteGroup

      Parameters:
      cancelTagSyncTaskRequest -
      Returns:
      A Java Future containing the result of the CancelTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTagSyncTask

      default CompletableFuture<CancelTagSyncTaskResponse> cancelTagSyncTask(Consumer<CancelTagSyncTaskRequest.Builder> cancelTagSyncTaskRequest)

      Cancels the specified tag-sync task.

      Minimum permissions

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

      • resource-groups:CancelTagSyncTask on the application group

      • resource-groups:DeleteGroup


      This is a convenience which creates an instance of the CancelTagSyncTaskRequest.Builder avoiding the need to create one manually via CancelTagSyncTaskRequest.builder()

      Parameters:
      cancelTagSyncTaskRequest - A Consumer that will call methods on CancelTagSyncTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)

      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

      Parameters:
      createGroupRequest -
      Returns:
      A Java Future containing the result of the CreateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)

      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


      This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to create one manually via CreateGroupRequest.builder()

      Parameters:
      createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)

      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

      Parameters:
      deleteGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)

      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


      This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to create one manually via DeleteGroupRequest.builder()

      Parameters:
      deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

      Retrieves the current status of optional features in Resource Groups.

      Parameters:
      getAccountSettingsRequest -
      Returns:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)

      Retrieves the current status of optional features in Resource Groups.


      This is a convenience which creates an instance of the GetAccountSettingsRequest.Builder avoiding the need to create one manually via GetAccountSettingsRequest.builder()

      Parameters:
      getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)

      Returns information about a specified resource group.

      Minimum permissions

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

      • resource-groups:GetGroup

      Parameters:
      getGroupRequest -
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)

      Returns information about a specified resource group.

      Minimum permissions

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

      • resource-groups:GetGroup


      This is a convenience which creates an instance of the GetGroupRequest.Builder avoiding the need to create one manually via GetGroupRequest.builder()

      Parameters:
      getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupConfiguration

      default CompletableFuture<GetGroupConfigurationResponse> getGroupConfiguration(GetGroupConfigurationRequest getGroupConfigurationRequest)

      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

      Parameters:
      getGroupConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetGroupConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupConfiguration

      default CompletableFuture<GetGroupConfigurationResponse> getGroupConfiguration(Consumer<GetGroupConfigurationRequest.Builder> getGroupConfigurationRequest)

      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


      This is a convenience which creates an instance of the GetGroupConfigurationRequest.Builder avoiding the need to create one manually via GetGroupConfigurationRequest.builder()

      Parameters:
      getGroupConfigurationRequest - A Consumer that will call methods on GetGroupConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroupConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupQuery

      default CompletableFuture<GetGroupQueryResponse> getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)

      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

      Parameters:
      getGroupQueryRequest -
      Returns:
      A Java Future containing the result of the GetGroupQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupQuery

      default CompletableFuture<GetGroupQueryResponse> getGroupQuery(Consumer<GetGroupQueryRequest.Builder> getGroupQueryRequest)

      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


      This is a convenience which creates an instance of the GetGroupQueryRequest.Builder avoiding the need to create one manually via GetGroupQueryRequest.builder()

      Parameters:
      getGroupQueryRequest - A Consumer that will call methods on GetGroupQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroupQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTagSyncTask

      default CompletableFuture<GetTagSyncTaskResponse> getTagSyncTask(GetTagSyncTaskRequest getTagSyncTaskRequest)

      Returns information about a specified tag-sync task.

      Minimum permissions

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

      • resource-groups:GetTagSyncTask on the application group

      Parameters:
      getTagSyncTaskRequest -
      Returns:
      A Java Future containing the result of the GetTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTagSyncTask

      default CompletableFuture<GetTagSyncTaskResponse> getTagSyncTask(Consumer<GetTagSyncTaskRequest.Builder> getTagSyncTaskRequest)

      Returns information about a specified tag-sync task.

      Minimum permissions

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

      • resource-groups:GetTagSyncTask on the application group


      This is a convenience which creates an instance of the GetTagSyncTaskRequest.Builder avoiding the need to create one manually via GetTagSyncTaskRequest.builder()

      Parameters:
      getTagSyncTaskRequest - A Consumer that will call methods on GetTagSyncTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTags

      default CompletableFuture<GetTagsResponse> getTags(GetTagsRequest getTagsRequest)

      Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).

      Minimum permissions

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

      • resource-groups:GetTags

      Parameters:
      getTagsRequest -
      Returns:
      A Java Future containing the result of the GetTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTags

      default CompletableFuture<GetTagsResponse> getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)

      Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).

      Minimum permissions

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

      • resource-groups:GetTags


      This is a convenience which creates an instance of the GetTagsRequest.Builder avoiding the need to create one manually via GetTagsRequest.builder()

      Parameters:
      getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • groupResources

      default CompletableFuture<GroupResourcesResponse> groupResources(GroupResourcesRequest groupResourcesRequest)

      Adds the specified resources to the specified group.

      You can only use this operation with the following groups:

      • AWS::EC2::HostManagement

      • AWS::EC2::CapacityReservationPool

      • AWS::ResourceGroups::ApplicationGroup

      Other resource group types and resource types are not currently supported by this operation.

      Minimum permissions

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

      • resource-groups:GroupResources

      Parameters:
      groupResourcesRequest -
      Returns:
      A Java Future containing the result of the GroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • groupResources

      default CompletableFuture<GroupResourcesResponse> groupResources(Consumer<GroupResourcesRequest.Builder> groupResourcesRequest)

      Adds the specified resources to the specified group.

      You can only use this operation with the following groups:

      • AWS::EC2::HostManagement

      • AWS::EC2::CapacityReservationPool

      • AWS::ResourceGroups::ApplicationGroup

      Other resource group types and resource types are not currently supported by this operation.

      Minimum permissions

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

      • resource-groups:GroupResources


      This is a convenience which creates an instance of the GroupResourcesRequest.Builder avoiding the need to create one manually via GroupResourcesRequest.builder()

      Parameters:
      groupResourcesRequest - A Consumer that will call methods on GroupResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupResources

      default CompletableFuture<ListGroupResourcesResponse> listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)

      Returns a list of Amazon resource names (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

      Parameters:
      listGroupResourcesRequest -
      Returns:
      A Java Future containing the result of the ListGroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupResources

      default CompletableFuture<ListGroupResourcesResponse> listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)

      Returns a list of Amazon resource names (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


      This is a convenience which creates an instance of the ListGroupResourcesRequest.Builder avoiding the need to create one manually via ListGroupResourcesRequest.builder()

      Parameters:
      listGroupResourcesRequest - A Consumer that will call methods on ListGroupResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupResourcesPaginator

      default ListGroupResourcesPublisher listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)

      This is a variant of listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest) operation.

      Parameters:
      listGroupResourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupResourcesPaginator

      default ListGroupResourcesPublisher listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)

      This is a variant of listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest) operation.


      This is a convenience which creates an instance of the ListGroupResourcesRequest.Builder avoiding the need to create one manually via ListGroupResourcesRequest.builder()

      Parameters:
      listGroupResourcesRequest - A Consumer that will call methods on ListGroupResourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupingStatuses

      default CompletableFuture<ListGroupingStatusesResponse> listGroupingStatuses(ListGroupingStatusesRequest listGroupingStatusesRequest)

      Returns the status of the last grouping or ungrouping action for each resource in the specified application group.

      Parameters:
      listGroupingStatusesRequest -
      Returns:
      A Java Future containing the result of the ListGroupingStatuses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupingStatuses

      default CompletableFuture<ListGroupingStatusesResponse> listGroupingStatuses(Consumer<ListGroupingStatusesRequest.Builder> listGroupingStatusesRequest)

      Returns the status of the last grouping or ungrouping action for each resource in the specified application group.


      This is a convenience which creates an instance of the ListGroupingStatusesRequest.Builder avoiding the need to create one manually via ListGroupingStatusesRequest.builder()

      Parameters:
      listGroupingStatusesRequest - A Consumer that will call methods on ListGroupingStatusesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroupingStatuses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupingStatusesPaginator

      default ListGroupingStatusesPublisher listGroupingStatusesPaginator(ListGroupingStatusesRequest listGroupingStatusesRequest)

      This is a variant of listGroupingStatuses(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupingStatusesPublisher publisher = client.listGroupingStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupingStatusesPublisher publisher = client.listGroupingStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroupingStatuses(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesRequest) operation.

      Parameters:
      listGroupingStatusesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupingStatusesPaginator

      default ListGroupingStatusesPublisher listGroupingStatusesPaginator(Consumer<ListGroupingStatusesRequest.Builder> listGroupingStatusesRequest)

      This is a variant of listGroupingStatuses(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupingStatusesPublisher publisher = client.listGroupingStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupingStatusesPublisher publisher = client.listGroupingStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroupingStatuses(software.amazon.awssdk.services.resourcegroups.model.ListGroupingStatusesRequest) operation.


      This is a convenience which creates an instance of the ListGroupingStatusesRequest.Builder avoiding the need to create one manually via ListGroupingStatusesRequest.builder()

      Parameters:
      listGroupingStatusesRequest - A Consumer that will call methods on ListGroupingStatusesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)

      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

      Parameters:
      listGroupsRequest -
      Returns:
      A Java Future containing the result of the ListGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      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


      This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups()

      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

      Returns:
      A Java Future containing the result of the ListGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator()

      This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation.

      Parameters:
      listGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest) operation.


      This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagSyncTasks

      default CompletableFuture<ListTagSyncTasksResponse> listTagSyncTasks(ListTagSyncTasksRequest listTagSyncTasksRequest)

      Returns a list of tag-sync tasks.

      Minimum permissions

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

      • resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters

      Parameters:
      listTagSyncTasksRequest -
      Returns:
      A Java Future containing the result of the ListTagSyncTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagSyncTasks

      default CompletableFuture<ListTagSyncTasksResponse> listTagSyncTasks(Consumer<ListTagSyncTasksRequest.Builder> listTagSyncTasksRequest)

      Returns a list of tag-sync tasks.

      Minimum permissions

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

      • resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters


      This is a convenience which creates an instance of the ListTagSyncTasksRequest.Builder avoiding the need to create one manually via ListTagSyncTasksRequest.builder()

      Parameters:
      listTagSyncTasksRequest - A Consumer that will call methods on ListTagSyncTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagSyncTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagSyncTasksPaginator

      default ListTagSyncTasksPublisher listTagSyncTasksPaginator(ListTagSyncTasksRequest listTagSyncTasksRequest)

      This is a variant of listTagSyncTasks(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListTagSyncTasksPublisher publisher = client.listTagSyncTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListTagSyncTasksPublisher publisher = client.listTagSyncTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagSyncTasks(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksRequest) operation.

      Parameters:
      listTagSyncTasksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagSyncTasksPaginator

      default ListTagSyncTasksPublisher listTagSyncTasksPaginator(Consumer<ListTagSyncTasksRequest.Builder> listTagSyncTasksRequest)

      This is a variant of listTagSyncTasks(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListTagSyncTasksPublisher publisher = client.listTagSyncTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.ListTagSyncTasksPublisher publisher = client.listTagSyncTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagSyncTasks(software.amazon.awssdk.services.resourcegroups.model.ListTagSyncTasksRequest) operation.


      This is a convenience which creates an instance of the ListTagSyncTasksRequest.Builder avoiding the need to create one manually via ListTagSyncTasksRequest.builder()

      Parameters:
      listTagSyncTasksRequest - A Consumer that will call methods on ListTagSyncTasksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putGroupConfiguration

      default CompletableFuture<PutGroupConfigurationResponse> putGroupConfiguration(PutGroupConfigurationRequest putGroupConfigurationRequest)

      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

      Parameters:
      putGroupConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutGroupConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putGroupConfiguration

      default CompletableFuture<PutGroupConfigurationResponse> putGroupConfiguration(Consumer<PutGroupConfigurationRequest.Builder> putGroupConfigurationRequest)

      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


      This is a convenience which creates an instance of the PutGroupConfigurationRequest.Builder avoiding the need to create one manually via PutGroupConfigurationRequest.builder()

      Parameters:
      putGroupConfigurationRequest - A Consumer that will call methods on PutGroupConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutGroupConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResources

      default CompletableFuture<SearchResourcesResponse> searchResources(SearchResourcesRequest searchResourcesRequest)

      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

      Parameters:
      searchResourcesRequest -
      Returns:
      A Java Future containing the result of the SearchResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResources

      default CompletableFuture<SearchResourcesResponse> searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)

      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


      This is a convenience which creates an instance of the SearchResourcesRequest.Builder avoiding the need to create one manually via SearchResourcesRequest.builder()

      Parameters:
      searchResourcesRequest - A Consumer that will call methods on SearchResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourcesPaginator

      default SearchResourcesPublisher searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)

      This is a variant of searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest) operation.

      Parameters:
      searchResourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourcesPaginator

      default SearchResourcesPublisher searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)

      This is a variant of searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest) operation.


      This is a convenience which creates an instance of the SearchResourcesRequest.Builder avoiding the need to create one manually via SearchResourcesRequest.builder()

      Parameters:
      searchResourcesRequest - A Consumer that will call methods on SearchResourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTagSyncTask

      default CompletableFuture<StartTagSyncTaskResponse> startTagSyncTask(StartTagSyncTaskRequest startTagSyncTaskRequest)

      Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.

      Minimum permissions

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

      • resource-groups:StartTagSyncTask on the application group

      • resource-groups:CreateGroup

      • iam:PassRole on the role provided in the request

      Parameters:
      startTagSyncTaskRequest -
      Returns:
      A Java Future containing the result of the StartTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTagSyncTask

      default CompletableFuture<StartTagSyncTaskResponse> startTagSyncTask(Consumer<StartTagSyncTaskRequest.Builder> startTagSyncTaskRequest)

      Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.

      Minimum permissions

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

      • resource-groups:StartTagSyncTask on the application group

      • resource-groups:CreateGroup

      • iam:PassRole on the role provided in the request


      This is a convenience which creates an instance of the StartTagSyncTaskRequest.Builder avoiding the need to create one manually via StartTagSyncTaskRequest.builder()

      Parameters:
      startTagSyncTaskRequest - A Consumer that will call methods on StartTagSyncTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTagSyncTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tag

      default CompletableFuture<TagResponse> tag(TagRequest tagRequest)

      Adds tags to a resource group with the specified Amazon resource name (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

      Parameters:
      tagRequest -
      Returns:
      A Java Future containing the result of the Tag operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tag

      default CompletableFuture<TagResponse> tag(Consumer<TagRequest.Builder> tagRequest)

      Adds tags to a resource group with the specified Amazon resource name (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


      This is a convenience which creates an instance of the TagRequest.Builder avoiding the need to create one manually via TagRequest.builder()

      Parameters:
      tagRequest - A Consumer that will call methods on TagRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Tag operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • ungroupResources

      default CompletableFuture<UngroupResourcesResponse> ungroupResources(UngroupResourcesRequest ungroupResourcesRequest)

      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

      Parameters:
      ungroupResourcesRequest -
      Returns:
      A Java Future containing the result of the UngroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • ungroupResources

      default CompletableFuture<UngroupResourcesResponse> ungroupResources(Consumer<UngroupResourcesRequest.Builder> ungroupResourcesRequest)

      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


      This is a convenience which creates an instance of the UngroupResourcesRequest.Builder avoiding the need to create one manually via UngroupResourcesRequest.builder()

      Parameters:
      ungroupResourcesRequest - A Consumer that will call methods on UngroupResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UngroupResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untag

      default CompletableFuture<UntagResponse> untag(UntagRequest untagRequest)

      Deletes tags from a specified resource group.

      Minimum permissions

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

      • resource-groups:Untag

      Parameters:
      untagRequest -
      Returns:
      A Java Future containing the result of the Untag operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untag

      default CompletableFuture<UntagResponse> untag(Consumer<UntagRequest.Builder> untagRequest)

      Deletes tags from a specified resource group.

      Minimum permissions

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

      • resource-groups:Untag


      This is a convenience which creates an instance of the UntagRequest.Builder avoiding the need to create one manually via UntagRequest.builder()

      Parameters:
      untagRequest - A Consumer that will call methods on UntagRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Untag operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)

      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.

      Parameters:
      updateAccountSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)

      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.


      This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder avoiding the need to create one manually via UpdateAccountSettingsRequest.builder()

      Parameters:
      updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)

      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

      Parameters:
      updateGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)

      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


      This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to create one manually via UpdateGroupRequest.builder()

      Parameters:
      updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroupQuery

      default CompletableFuture<UpdateGroupQueryResponse> updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest)

      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

      Parameters:
      updateGroupQueryRequest -
      Returns:
      A Java Future containing the result of the UpdateGroupQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroupQuery

      default CompletableFuture<UpdateGroupQueryResponse> updateGroupQuery(Consumer<UpdateGroupQueryRequest.Builder> updateGroupQueryRequest)

      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


      This is a convenience which creates an instance of the UpdateGroupQueryRequest.Builder avoiding the need to create one manually via UpdateGroupQueryRequest.builder()

      Parameters:
      updateGroupQueryRequest - A Consumer that will call methods on UpdateGroupQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGroupQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The request includes one or more parameters that violate validation rules.
      • ForbiddenException The caller isn't authorized to make the request. Check permissions.
      • NotFoundException One or more of the specified resources don't exist.
      • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.
      • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.
      • InternalServerErrorException An internal error occurred while processing the request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ResourceGroupsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ResourceGroupsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ResourceGroupsAsyncClient create()
      Create a ResourceGroupsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ResourceGroupsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ResourceGroupsAsyncClient.