Skip to content

ResourceGroupsClient#

Index > ResourceGroups > ResourceGroupsClient

Auto-generated documentation for ResourceGroups type annotations stubs module types-boto3-resource-groups.

ResourceGroupsClient#

Type annotations and code completion for boto3.client("resource-groups"). boto3 documentation

# ResourceGroupsClient usage example

from boto3.session import Session
from types_boto3_resource_groups.client import ResourceGroupsClient

def get_resource-groups_client() -> ResourceGroupsClient:
    return Session().client("resource-groups")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("resource-groups").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("resource-groups")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.MethodNotAllowedException,
    client.exceptions.NotFoundException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_resource_groups.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("resource-groups").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("resource-groups").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_tag_sync_task#

Cancels the specified tag-sync task.

Type annotations and code completion for boto3.client("resource-groups").cancel_tag_sync_task method. boto3 documentation

# cancel_tag_sync_task method definition

def cancel_tag_sync_task(
    self,
    *,
    TaskArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# cancel_tag_sync_task method usage example with argument unpacking

kwargs: CancelTagSyncTaskInputTypeDef = {  # (1)
    "TaskArn": ...,
}

parent.cancel_tag_sync_task(**kwargs)
  1. See CancelTagSyncTaskInputTypeDef

create_group#

Creates a resource group with the specified name and description.

Type annotations and code completion for boto3.client("resource-groups").create_group method. boto3 documentation

# create_group method definition

def create_group(
    self,
    *,
    Name: str,
    Description: str = ...,
    ResourceQuery: ResourceQueryTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
    Configuration: Sequence[GroupConfigurationItemUnionTypeDef] = ...,  # (2)
    Criticality: int = ...,
    Owner: str = ...,
    DisplayName: str = ...,
) -> CreateGroupOutputTypeDef:  # (3)
    ...
  1. See ResourceQueryTypeDef
  2. See Sequence[GroupConfigurationItemUnionTypeDef]
  3. See CreateGroupOutputTypeDef
# create_group method usage example with argument unpacking

kwargs: CreateGroupInputTypeDef = {  # (1)
    "Name": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupInputTypeDef

delete_group#

Deletes the specified resource group.

Type annotations and code completion for boto3.client("resource-groups").delete_group method. boto3 documentation

# delete_group method definition

def delete_group(
    self,
    *,
    GroupName: str = ...,
    Group: str = ...,
) -> DeleteGroupOutputTypeDef:  # (1)
    ...
  1. See DeleteGroupOutputTypeDef
# delete_group method usage example with argument unpacking

kwargs: DeleteGroupInputTypeDef = {  # (1)
    "GroupName": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupInputTypeDef

get_account_settings#

Retrieves the current status of optional features in Resource Groups.

Type annotations and code completion for boto3.client("resource-groups").get_account_settings method. boto3 documentation

# get_account_settings method definition

def get_account_settings(
    self,
) -> GetAccountSettingsOutputTypeDef:  # (1)
    ...
  1. See GetAccountSettingsOutputTypeDef

get_group#

Returns information about a specified resource group.

Type annotations and code completion for boto3.client("resource-groups").get_group method. boto3 documentation

# get_group method definition

def get_group(
    self,
    *,
    GroupName: str = ...,
    Group: str = ...,
) -> GetGroupOutputTypeDef:  # (1)
    ...
  1. See GetGroupOutputTypeDef
# get_group method usage example with argument unpacking

kwargs: GetGroupInputTypeDef = {  # (1)
    "GroupName": ...,
}

parent.get_group(**kwargs)
  1. See GetGroupInputTypeDef

get_group_configuration#

Retrieves the service configuration associated with the specified resource group.

Type annotations and code completion for boto3.client("resource-groups").get_group_configuration method. boto3 documentation

# get_group_configuration method definition

def get_group_configuration(
    self,
    *,
    Group: str = ...,
) -> GetGroupConfigurationOutputTypeDef:  # (1)
    ...
  1. See GetGroupConfigurationOutputTypeDef
# get_group_configuration method usage example with argument unpacking

kwargs: GetGroupConfigurationInputTypeDef = {  # (1)
    "Group": ...,
}

parent.get_group_configuration(**kwargs)
  1. See GetGroupConfigurationInputTypeDef

get_group_query#

Retrieves the resource query associated with the specified resource group.

Type annotations and code completion for boto3.client("resource-groups").get_group_query method. boto3 documentation

# get_group_query method definition

def get_group_query(
    self,
    *,
    GroupName: str = ...,
    Group: str = ...,
) -> GetGroupQueryOutputTypeDef:  # (1)
    ...
  1. See GetGroupQueryOutputTypeDef
# get_group_query method usage example with argument unpacking

kwargs: GetGroupQueryInputTypeDef = {  # (1)
    "GroupName": ...,
}

parent.get_group_query(**kwargs)
  1. See GetGroupQueryInputTypeDef

get_tag_sync_task#

Returns information about a specified tag-sync task.

Type annotations and code completion for boto3.client("resource-groups").get_tag_sync_task method. boto3 documentation

# get_tag_sync_task method definition

def get_tag_sync_task(
    self,
    *,
    TaskArn: str,
) -> GetTagSyncTaskOutputTypeDef:  # (1)
    ...
  1. See GetTagSyncTaskOutputTypeDef
# get_tag_sync_task method usage example with argument unpacking

kwargs: GetTagSyncTaskInputTypeDef = {  # (1)
    "TaskArn": ...,
}

parent.get_tag_sync_task(**kwargs)
  1. See GetTagSyncTaskInputTypeDef

get_tags#

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

Type annotations and code completion for boto3.client("resource-groups").get_tags method. boto3 documentation

# get_tags method definition

def get_tags(
    self,
    *,
    Arn: str,
) -> GetTagsOutputTypeDef:  # (1)
    ...
  1. See GetTagsOutputTypeDef
# get_tags method usage example with argument unpacking

kwargs: GetTagsInputTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_tags(**kwargs)
  1. See GetTagsInputTypeDef

group_resources#

Adds the specified resources to the specified group.

Type annotations and code completion for boto3.client("resource-groups").group_resources method. boto3 documentation

# group_resources method definition

def group_resources(
    self,
    *,
    Group: str,
    ResourceArns: Sequence[str],
) -> GroupResourcesOutputTypeDef:  # (1)
    ...
  1. See GroupResourcesOutputTypeDef
# group_resources method usage example with argument unpacking

kwargs: GroupResourcesInputTypeDef = {  # (1)
    "Group": ...,
    "ResourceArns": ...,
}

parent.group_resources(**kwargs)
  1. See GroupResourcesInputTypeDef

list_group_resources#

Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.

Type annotations and code completion for boto3.client("resource-groups").list_group_resources method. boto3 documentation

# list_group_resources method definition

def list_group_resources(
    self,
    *,
    GroupName: str = ...,
    Group: str = ...,
    Filters: Sequence[ResourceFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGroupResourcesOutputTypeDef:  # (2)
    ...
  1. See Sequence[ResourceFilterTypeDef]
  2. See ListGroupResourcesOutputTypeDef
# list_group_resources method usage example with argument unpacking

kwargs: ListGroupResourcesInputTypeDef = {  # (1)
    "GroupName": ...,
}

parent.list_group_resources(**kwargs)
  1. See ListGroupResourcesInputTypeDef

list_grouping_statuses#

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

Type annotations and code completion for boto3.client("resource-groups").list_grouping_statuses method. boto3 documentation

# list_grouping_statuses method definition

def list_grouping_statuses(
    self,
    *,
    Group: str,
    MaxResults: int = ...,
    Filters: Sequence[ListGroupingStatusesFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
) -> ListGroupingStatusesOutputTypeDef:  # (2)
    ...
  1. See Sequence[ListGroupingStatusesFilterTypeDef]
  2. See ListGroupingStatusesOutputTypeDef
# list_grouping_statuses method usage example with argument unpacking

kwargs: ListGroupingStatusesInputTypeDef = {  # (1)
    "Group": ...,
}

parent.list_grouping_statuses(**kwargs)
  1. See ListGroupingStatusesInputTypeDef

list_groups#

Returns a list of existing Resource Groups in your account.

Type annotations and code completion for boto3.client("resource-groups").list_groups method. boto3 documentation

# list_groups method definition

def list_groups(
    self,
    *,
    Filters: Sequence[GroupFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGroupsOutputTypeDef:  # (2)
    ...
  1. See Sequence[GroupFilterTypeDef]
  2. See ListGroupsOutputTypeDef
# list_groups method usage example with argument unpacking

kwargs: ListGroupsInputTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsInputTypeDef

list_tag_sync_tasks#

Returns a list of tag-sync tasks.

Type annotations and code completion for boto3.client("resource-groups").list_tag_sync_tasks method. boto3 documentation

# list_tag_sync_tasks method definition

def list_tag_sync_tasks(
    self,
    *,
    Filters: Sequence[ListTagSyncTasksFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagSyncTasksOutputTypeDef:  # (2)
    ...
  1. See Sequence[ListTagSyncTasksFilterTypeDef]
  2. See ListTagSyncTasksOutputTypeDef
# list_tag_sync_tasks method usage example with argument unpacking

kwargs: ListTagSyncTasksInputTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_tag_sync_tasks(**kwargs)
  1. See ListTagSyncTasksInputTypeDef

put_group_configuration#

Attaches a service configuration to the specified group.

Type annotations and code completion for boto3.client("resource-groups").put_group_configuration method. boto3 documentation

# put_group_configuration method definition

def put_group_configuration(
    self,
    *,
    Group: str = ...,
    Configuration: Sequence[GroupConfigurationItemUnionTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[GroupConfigurationItemUnionTypeDef]
# put_group_configuration method usage example with argument unpacking

kwargs: PutGroupConfigurationInputTypeDef = {  # (1)
    "Group": ...,
}

parent.put_group_configuration(**kwargs)
  1. See PutGroupConfigurationInputTypeDef

search_resources#

Returns a list of Amazon Web Services resource identifiers that matches the specified query.

Type annotations and code completion for boto3.client("resource-groups").search_resources method. boto3 documentation

# search_resources method definition

def search_resources(
    self,
    *,
    ResourceQuery: ResourceQueryTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchResourcesOutputTypeDef:  # (2)
    ...
  1. See ResourceQueryTypeDef
  2. See SearchResourcesOutputTypeDef
# search_resources method usage example with argument unpacking

kwargs: SearchResourcesInputTypeDef = {  # (1)
    "ResourceQuery": ...,
}

parent.search_resources(**kwargs)
  1. See SearchResourcesInputTypeDef

start_tag_sync_task#

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

Type annotations and code completion for boto3.client("resource-groups").start_tag_sync_task method. boto3 documentation

# start_tag_sync_task method definition

def start_tag_sync_task(
    self,
    *,
    Group: str,
    RoleArn: str,
    TagKey: str = ...,
    TagValue: str = ...,
    ResourceQuery: ResourceQueryTypeDef = ...,  # (1)
) -> StartTagSyncTaskOutputTypeDef:  # (2)
    ...
  1. See ResourceQueryTypeDef
  2. See StartTagSyncTaskOutputTypeDef
# start_tag_sync_task method usage example with argument unpacking

kwargs: StartTagSyncTaskInputTypeDef = {  # (1)
    "Group": ...,
    "RoleArn": ...,
}

parent.start_tag_sync_task(**kwargs)
  1. See StartTagSyncTaskInputTypeDef

tag#

Adds tags to a resource group with the specified Amazon resource name (ARN).

Type annotations and code completion for boto3.client("resource-groups").tag method. boto3 documentation

# tag method definition

def tag(
    self,
    *,
    Arn: str,
    Tags: Mapping[str, str],
) -> TagOutputTypeDef:  # (1)
    ...
  1. See TagOutputTypeDef
# tag method usage example with argument unpacking

kwargs: TagInputTypeDef = {  # (1)
    "Arn": ...,
    "Tags": ...,
}

parent.tag(**kwargs)
  1. See TagInputTypeDef

ungroup_resources#

Removes the specified resources from the specified group.

Type annotations and code completion for boto3.client("resource-groups").ungroup_resources method. boto3 documentation

# ungroup_resources method definition

def ungroup_resources(
    self,
    *,
    Group: str,
    ResourceArns: Sequence[str],
) -> UngroupResourcesOutputTypeDef:  # (1)
    ...
  1. See UngroupResourcesOutputTypeDef
# ungroup_resources method usage example with argument unpacking

kwargs: UngroupResourcesInputTypeDef = {  # (1)
    "Group": ...,
    "ResourceArns": ...,
}

parent.ungroup_resources(**kwargs)
  1. See UngroupResourcesInputTypeDef

untag#

Deletes tags from a specified resource group.

Type annotations and code completion for boto3.client("resource-groups").untag method. boto3 documentation

# untag method definition

def untag(
    self,
    *,
    Arn: str,
    Keys: Sequence[str],
) -> UntagOutputTypeDef:  # (1)
    ...
  1. See UntagOutputTypeDef
# untag method usage example with argument unpacking

kwargs: UntagInputTypeDef = {  # (1)
    "Arn": ...,
    "Keys": ...,
}

parent.untag(**kwargs)
  1. See UntagInputTypeDef

update_account_settings#

Turns on or turns off optional features in Resource Groups.

Type annotations and code completion for boto3.client("resource-groups").update_account_settings method. boto3 documentation

# update_account_settings method definition

def update_account_settings(
    self,
    *,
    GroupLifecycleEventsDesiredStatus: GroupLifecycleEventsDesiredStatusType = ...,  # (1)
) -> UpdateAccountSettingsOutputTypeDef:  # (2)
    ...
  1. See GroupLifecycleEventsDesiredStatusType
  2. See UpdateAccountSettingsOutputTypeDef
# update_account_settings method usage example with argument unpacking

kwargs: UpdateAccountSettingsInputTypeDef = {  # (1)
    "GroupLifecycleEventsDesiredStatus": ...,
}

parent.update_account_settings(**kwargs)
  1. See UpdateAccountSettingsInputTypeDef

update_group#

Updates the description for an existing group.

Type annotations and code completion for boto3.client("resource-groups").update_group method. boto3 documentation

# update_group method definition

def update_group(
    self,
    *,
    GroupName: str = ...,
    Group: str = ...,
    Description: str = ...,
    Criticality: int = ...,
    Owner: str = ...,
    DisplayName: str = ...,
) -> UpdateGroupOutputTypeDef:  # (1)
    ...
  1. See UpdateGroupOutputTypeDef
# update_group method usage example with argument unpacking

kwargs: UpdateGroupInputTypeDef = {  # (1)
    "GroupName": ...,
}

parent.update_group(**kwargs)
  1. See UpdateGroupInputTypeDef

update_group_query#

Updates the resource query of a group.

Type annotations and code completion for boto3.client("resource-groups").update_group_query method. boto3 documentation

# update_group_query method definition

def update_group_query(
    self,
    *,
    ResourceQuery: ResourceQueryTypeDef,  # (1)
    GroupName: str = ...,
    Group: str = ...,
) -> UpdateGroupQueryOutputTypeDef:  # (2)
    ...
  1. See ResourceQueryTypeDef
  2. See UpdateGroupQueryOutputTypeDef
# update_group_query method usage example with argument unpacking

kwargs: UpdateGroupQueryInputTypeDef = {  # (1)
    "ResourceQuery": ...,
}

parent.update_group_query(**kwargs)
  1. See UpdateGroupQueryInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("resource-groups").get_paginator method with overloads.