ResourceGroupsTaggingAPIClient
Index > ResourceGroupsTaggingAPI > ResourceGroupsTaggingAPIClient
Auto-generated documentation for ResourceGroupsTaggingAPI type annotations stubs module types-aiobotocore-resourcegroupstaggingapi.
ResourceGroupsTaggingAPIClient
Type annotations and code completion for session.client("resourcegroupstaggingapi")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_resourcegroupstaggingapi.client import ResourceGroupsTaggingAPIClient
session = Session()
async with session.client("resourcegroupstaggingapi") as client:
client: ResourceGroupsTaggingAPIClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("resourcegroupstaggingapi").exceptions
structure.
async with session.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)
from types_aiobotocore_resourcegroupstaggingapi.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("resourcegroupstaggingapi").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("resourcegroupstaggingapi").close
method.
boto3 documentation
describe_report_creation
Describes the status of the StartReportCreation
operation.
Type annotations and code completion for session.client("resourcegroupstaggingapi").describe_report_creation
method.
boto3 documentation
await def describe_report_creation(
self,
) -> DescribeReportCreationOutputTypeDef: # (1)
...
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("resourcegroupstaggingapi").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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.client("resourcegroupstaggingapi").get_compliance_summary
method.
boto3 documentation
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)
...
kwargs: GetComplianceSummaryInputRequestTypeDef = { # (1)
"TargetIdFilters": ...,
}
parent.get_compliance_summary(**kwargs)
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.client("resourcegroupstaggingapi").get_resources
method.
boto3 documentation
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)
...
kwargs: GetResourcesInputRequestTypeDef = { # (1)
"PaginationToken": ...,
}
parent.get_resources(**kwargs)
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.client("resourcegroupstaggingapi").get_tag_keys
method.
boto3 documentation
await def get_tag_keys(
self,
*,
PaginationToken: str = ...,
) -> GetTagKeysOutputTypeDef: # (1)
...
kwargs: GetTagKeysInputRequestTypeDef = { # (1)
"PaginationToken": ...,
}
parent.get_tag_keys(**kwargs)
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.client("resourcegroupstaggingapi").get_tag_values
method.
boto3 documentation
await def get_tag_values(
self,
*,
Key: str,
PaginationToken: str = ...,
) -> GetTagValuesOutputTypeDef: # (1)
...
kwargs: GetTagValuesInputRequestTypeDef = { # (1)
"Key": ...,
}
parent.get_tag_values(**kwargs)
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.client("resourcegroupstaggingapi").start_report_creation
method.
boto3 documentation
kwargs: StartReportCreationInputRequestTypeDef = { # (1)
"S3Bucket": ...,
}
parent.start_report_creation(**kwargs)
tag_resources
.
Type annotations and code completion for session.client("resourcegroupstaggingapi").tag_resources
method.
boto3 documentation
await def tag_resources(
self,
*,
ResourceARNList: Sequence[str],
Tags: Mapping[str, str],
) -> TagResourcesOutputTypeDef: # (1)
...
kwargs: TagResourcesInputRequestTypeDef = { # (1)
"ResourceARNList": ...,
"Tags": ...,
}
parent.tag_resources(**kwargs)
untag_resources
.
Type annotations and code completion for session.client("resourcegroupstaggingapi").untag_resources
method.
boto3 documentation
await def untag_resources(
self,
*,
ResourceARNList: Sequence[str],
TagKeys: Sequence[str],
) -> UntagResourcesOutputTypeDef: # (1)
...
kwargs: UntagResourcesInputRequestTypeDef = { # (1)
"ResourceARNList": ...,
"TagKeys": ...,
}
parent.untag_resources(**kwargs)
__aenter__
Type annotations and code completion for session.client("resourcegroupstaggingapi").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("resourcegroupstaggingapi").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("resourcegroupstaggingapi").get_paginator
method with overloads.
client.get_paginator("get_compliance_summary")
-> GetComplianceSummaryPaginatorclient.get_paginator("get_resources")
-> GetResourcesPaginatorclient.get_paginator("get_tag_keys")
-> GetTagKeysPaginatorclient.get_paginator("get_tag_values")
-> GetTagValuesPaginator