Skip to content

ResourceGroupsTaggingAPIClient#

Index > ResourceGroupsTaggingAPI > ResourceGroupsTaggingAPIClient

Auto-generated documentation for ResourceGroupsTaggingAPI type annotations stubs module types-aiobotocore-resourcegroupstaggingapi.

ResourceGroupsTaggingAPIClient#

Type annotations and code completion for session.create_client("resourcegroupstaggingapi") boto3 documentation

# ResourceGroupsTaggingAPIClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_resourcegroupstaggingapi.client import ResourceGroupsTaggingAPIClient

session = get_session()
async with session.create_client("resourcegroupstaggingapi") as client:
    client: ResourceGroupsTaggingAPIClient

Exceptions#

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("resourcegroupstaggingapi").exceptions structure.

# ResourceGroupsTaggingAPIClient.exceptions usage example

async with session.create_client("resourcegroupstaggingapi") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConcurrentModificationException,
        client.ConstraintViolationException,
        client.InternalServiceException,
        client.InvalidParameterException,
        client.PaginationTokenExpiredException,
        client.ThrottledException,
    ) as e:
        print(e)
# ResourceGroupsTaggingAPIClient usage type checking example

from types_aiobotocore_resourcegroupstaggingapi.client import Exceptions

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

Methods#

can_paginate#

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").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 session.create_client("resourcegroupstaggingapi").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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

describe_report_creation#

Describes the status of the StartReportCreation operation.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").describe_report_creation method. boto3 documentation

# describe_report_creation method definition

await def describe_report_creation(
    self,
) -> DescribeReportCreationOutputTypeDef:  # (1)
    ...
  1. See DescribeReportCreationOutputTypeDef

get_compliance_summary#

Returns a table that shows counts of resources that are noncompliant with their tag policies.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").get_compliance_summary method. boto3 documentation

# get_compliance_summary method definition

await def get_compliance_summary(
    self,
    *,
    TargetIdFilters: Sequence[str] = ...,
    RegionFilters: Sequence[str] = ...,
    ResourceTypeFilters: Sequence[str] = ...,
    TagKeyFilters: Sequence[str] = ...,
    GroupBy: Sequence[GroupByAttributeType] = ...,  # (1)
    MaxResults: int = ...,
    PaginationToken: str = ...,
) -> GetComplianceSummaryOutputTypeDef:  # (2)
    ...
  1. See Sequence[GroupByAttributeType]
  2. See GetComplianceSummaryOutputTypeDef
# get_compliance_summary method usage example with argument unpacking

kwargs: GetComplianceSummaryInputTypeDef = {  # (1)
    "TargetIdFilters": ...,
}

parent.get_compliance_summary(**kwargs)
  1. See GetComplianceSummaryInputTypeDef

get_resources#

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").get_resources method. boto3 documentation

# get_resources method definition

await def get_resources(
    self,
    *,
    PaginationToken: str = ...,
    TagFilters: Sequence[TagFilterTypeDef] = ...,  # (1)
    ResourcesPerPage: int = ...,
    TagsPerPage: int = ...,
    ResourceTypeFilters: Sequence[str] = ...,
    IncludeComplianceDetails: bool = ...,
    ExcludeCompliantResources: bool = ...,
    ResourceARNList: Sequence[str] = ...,
) -> GetResourcesOutputTypeDef:  # (2)
    ...
  1. See Sequence[TagFilterTypeDef]
  2. See GetResourcesOutputTypeDef
# get_resources method usage example with argument unpacking

kwargs: GetResourcesInputTypeDef = {  # (1)
    "PaginationToken": ...,
}

parent.get_resources(**kwargs)
  1. See GetResourcesInputTypeDef

get_tag_keys#

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").get_tag_keys method. boto3 documentation

# get_tag_keys method definition

await def get_tag_keys(
    self,
    *,
    PaginationToken: str = ...,
) -> GetTagKeysOutputTypeDef:  # (1)
    ...
  1. See GetTagKeysOutputTypeDef
# get_tag_keys method usage example with argument unpacking

kwargs: GetTagKeysInputTypeDef = {  # (1)
    "PaginationToken": ...,
}

parent.get_tag_keys(**kwargs)
  1. See GetTagKeysInputTypeDef

get_tag_values#

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").get_tag_values method. boto3 documentation

# get_tag_values method definition

await def get_tag_values(
    self,
    *,
    Key: str,
    PaginationToken: str = ...,
) -> GetTagValuesOutputTypeDef:  # (1)
    ...
  1. See GetTagValuesOutputTypeDef
# get_tag_values method usage example with argument unpacking

kwargs: GetTagValuesInputTypeDef = {  # (1)
    "Key": ...,
}

parent.get_tag_values(**kwargs)
  1. See GetTagValuesInputTypeDef

start_report_creation#

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

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").start_report_creation method. boto3 documentation

# start_report_creation method definition

await def start_report_creation(
    self,
    *,
    S3Bucket: str,
) -> Dict[str, Any]:
    ...
# start_report_creation method usage example with argument unpacking

kwargs: StartReportCreationInputTypeDef = {  # (1)
    "S3Bucket": ...,
}

parent.start_report_creation(**kwargs)
  1. See StartReportCreationInputTypeDef

tag_resources#

Applies one or more tags to the specified resources.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").tag_resources method. boto3 documentation

# tag_resources method definition

await def tag_resources(
    self,
    *,
    ResourceARNList: Sequence[str],
    Tags: Mapping[str, str],
) -> TagResourcesOutputTypeDef:  # (1)
    ...
  1. See TagResourcesOutputTypeDef
# tag_resources method usage example with argument unpacking

kwargs: TagResourcesInputTypeDef = {  # (1)
    "ResourceARNList": ...,
    "Tags": ...,
}

parent.tag_resources(**kwargs)
  1. See TagResourcesInputTypeDef

untag_resources#

Removes the specified tags from the specified resources.

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").untag_resources method. boto3 documentation

# untag_resources method definition

await def untag_resources(
    self,
    *,
    ResourceARNList: Sequence[str],
    TagKeys: Sequence[str],
) -> UntagResourcesOutputTypeDef:  # (1)
    ...
  1. See UntagResourcesOutputTypeDef
# untag_resources method usage example with argument unpacking

kwargs: UntagResourcesInputTypeDef = {  # (1)
    "ResourceARNList": ...,
    "TagKeys": ...,
}

parent.untag_resources(**kwargs)
  1. See UntagResourcesInputTypeDef

__aenter__#

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> Self:
    ...

__aexit__#

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Type[BaseException] | None,
    exc_val: BaseException | None,
    exc_tb: types.TracebackType | None,
) -> None:
    ...

get_paginator#

Type annotations and code completion for session.create_client("resourcegroupstaggingapi").get_paginator method with overloads.