Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use resourcegroupstaggingapi method in localstack

Best Python code snippet using localstack_python

client.pyi

Source:client.pyi

1"""2Type annotations for resourcegroupstaggingapi service client.3[Open documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html)4Usage::5    ```python6    import boto37    from mypy_boto3_resourcegroupstaggingapi import ResourceGroupsTaggingAPIClient8    client: ResourceGroupsTaggingAPIClient = boto3.client("resourcegroupstaggingapi")9    ```10"""11import sys12from typing import Any, Dict, List, Type, overload13from botocore.client import BaseClient, ClientMeta14from .literals import GroupByAttributeType15from .paginator import (16    GetComplianceSummaryPaginator,17    GetResourcesPaginator,18    GetTagKeysPaginator,19    GetTagValuesPaginator,20)21from .type_defs import (22    DescribeReportCreationOutputTypeDef,23    GetComplianceSummaryOutputTypeDef,24    GetResourcesOutputTypeDef,25    GetTagKeysOutputTypeDef,26    GetTagValuesOutputTypeDef,27    TagFilterTypeDef,28    TagResourcesOutputTypeDef,29    UntagResourcesOutputTypeDef,30)31if sys.version_info >= (3, 8):32    from typing import Literal33else:34    from typing_extensions import Literal35__all__ = ("ResourceGroupsTaggingAPIClient",)36class BotocoreClientError(BaseException):37    MSG_TEMPLATE: str38    def __init__(self, error_response: Dict[str, Any], operation_name: str) -> None:39        self.response: Dict[str, Any]40        self.operation_name: str41class Exceptions:42    ClientError: Type[BotocoreClientError]43    ConcurrentModificationException: Type[BotocoreClientError]44    ConstraintViolationException: Type[BotocoreClientError]45    InternalServiceException: Type[BotocoreClientError]46    InvalidParameterException: Type[BotocoreClientError]47    PaginationTokenExpiredException: Type[BotocoreClientError]48    ThrottledException: Type[BotocoreClientError]49class ResourceGroupsTaggingAPIClient(BaseClient):50    """51    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client)52    [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html)53    """54    meta: ClientMeta55    @property56    def exceptions(self) -> Exceptions:57        """58        ResourceGroupsTaggingAPIClient exceptions.59        """60    def can_paginate(self, operation_name: str) -> bool:61        """62        Check if an operation can be paginated.63        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.can_paginate)64        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#can_paginate)65        """66    def close(self) -> None:67        """68        Closes underlying endpoint connections.69        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.close)70        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#close)71        """72    def describe_report_creation(self) -> DescribeReportCreationOutputTypeDef:73        """74        Describes the status of the `StartReportCreation` operation.75        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.describe_report_creation)76        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#describe_report_creation)77        """78    def generate_presigned_url(79        self,80        ClientMethod: str,81        Params: Dict[str, Any] = None,82        ExpiresIn: int = 3600,83        HttpMethod: str = None,84    ) -> str:85        """86        Generate a presigned url given a client, its method, and arguments.87        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.generate_presigned_url)88        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#generate_presigned_url)89        """90    def get_compliance_summary(91        self,92        *,93        TargetIdFilters: List[str] = None,94        RegionFilters: List[str] = None,95        ResourceTypeFilters: List[str] = None,96        TagKeyFilters: List[str] = None,97        GroupBy: List[GroupByAttributeType] = None,98        MaxResults: int = None,99        PaginationToken: str = None100    ) -> GetComplianceSummaryOutputTypeDef:101        """102        Returns a table that shows counts of resources that are noncompliant with their103        tag policies.104        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.get_compliance_summary)105        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#get_compliance_summary)106        """107    def get_resources(108        self,109        *,110        PaginationToken: str = None,111        TagFilters: List["TagFilterTypeDef"] = None,112        ResourcesPerPage: int = None,113        TagsPerPage: int = None,114        ResourceTypeFilters: List[str] = None,115        IncludeComplianceDetails: bool = None,116        ExcludeCompliantResources: bool = None,117        ResourceARNList: List[str] = None118    ) -> GetResourcesOutputTypeDef:119        """120        Returns all the tagged or previously tagged resources that are located in the121        specified Amazon Web Services Region for the account.122        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.get_resources)123        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#get_resources)124        """125    def get_tag_keys(self, *, PaginationToken: str = None) -> GetTagKeysOutputTypeDef:126        """127        Returns all tag keys currently in use in the specified Amazon Web Services128        Region for the calling account.129        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.get_tag_keys)130        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#get_tag_keys)131        """132    def get_tag_values(self, *, Key: str, PaginationToken: str = None) -> GetTagValuesOutputTypeDef:133        """134        Returns all tag values for the specified key that are used in the specified135        Amazon Web Services Region for the calling account.136        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.get_tag_values)137        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#get_tag_values)138        """139    def start_report_creation(self, *, S3Bucket: str) -> Dict[str, Any]:140        """141        Generates a report that lists all tagged resources in the accounts across your142        organization and tells whether each resource is compliant with the effective tag143        policy.144        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.start_report_creation)145        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#start_report_creation)146        """147    def tag_resources(148        self, *, ResourceARNList: List[str], Tags: Dict[str, str]149    ) -> TagResourcesOutputTypeDef:150        """151        .152        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.tag_resources)153        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#tag_resources)154        """155    def untag_resources(156        self, *, ResourceARNList: List[str], TagKeys: List[str]157    ) -> UntagResourcesOutputTypeDef:158        """159        .160        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Client.untag_resources)161        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/client.html#untag_resources)162        """163    @overload164    def get_paginator(165        self, operation_name: Literal["get_compliance_summary"]166    ) -> GetComplianceSummaryPaginator:167        """168        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary)169        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getcompliancesummarypaginator)170        """171    @overload172    def get_paginator(self, operation_name: Literal["get_resources"]) -> GetResourcesPaginator:173        """174        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetResources)175        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getresourcespaginator)176        """177    @overload178    def get_paginator(self, operation_name: Literal["get_tag_keys"]) -> GetTagKeysPaginator:179        """180        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagKeys)181        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagkeyspaginator)182        """183    @overload184    def get_paginator(self, operation_name: Literal["get_tag_values"]) -> GetTagValuesPaginator:185        """186        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagValues)187        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagvaluespaginator)...

paginator.pyi

Source:paginator.pyi

1"""2Type annotations for resourcegroupstaggingapi service client paginators.3[Open documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html)4Usage::5    ```python6    import boto37    from mypy_boto3_resourcegroupstaggingapi import ResourceGroupsTaggingAPIClient8    from mypy_boto3_resourcegroupstaggingapi.paginator import (9        GetComplianceSummaryPaginator,10        GetResourcesPaginator,11        GetTagKeysPaginator,12        GetTagValuesPaginator,13    )14    client: ResourceGroupsTaggingAPIClient = boto3.client("resourcegroupstaggingapi")15    get_compliance_summary_paginator: GetComplianceSummaryPaginator = client.get_paginator("get_compliance_summary")16    get_resources_paginator: GetResourcesPaginator = client.get_paginator("get_resources")17    get_tag_keys_paginator: GetTagKeysPaginator = client.get_paginator("get_tag_keys")18    get_tag_values_paginator: GetTagValuesPaginator = client.get_paginator("get_tag_values")19    ```20"""21from typing import Iterator, List22from botocore.paginate import Paginator as Boto3Paginator23from .literals import GroupByAttributeType24from .type_defs import (25    GetComplianceSummaryOutputTypeDef,26    GetResourcesOutputTypeDef,27    GetTagKeysOutputTypeDef,28    GetTagValuesOutputTypeDef,29    PaginatorConfigTypeDef,30    TagFilterTypeDef,31)32__all__ = (33    "GetComplianceSummaryPaginator",34    "GetResourcesPaginator",35    "GetTagKeysPaginator",36    "GetTagValuesPaginator",37)38class GetComplianceSummaryPaginator(Boto3Paginator):39    """40    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary)41    [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getcompliancesummarypaginator)42    """43    def paginate(44        self,45        *,46        TargetIdFilters: List[str] = None,47        RegionFilters: List[str] = None,48        ResourceTypeFilters: List[str] = None,49        TagKeyFilters: List[str] = None,50        GroupBy: List[GroupByAttributeType] = None,51        PaginationConfig: PaginatorConfigTypeDef = None52    ) -> Iterator[GetComplianceSummaryOutputTypeDef]:53        """54        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary.paginate)55        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getcompliancesummarypaginator)56        """57class GetResourcesPaginator(Boto3Paginator):58    """59    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetResources)60    [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getresourcespaginator)61    """62    def paginate(63        self,64        *,65        TagFilters: List["TagFilterTypeDef"] = None,66        TagsPerPage: int = None,67        ResourceTypeFilters: List[str] = None,68        IncludeComplianceDetails: bool = None,69        ExcludeCompliantResources: bool = None,70        ResourceARNList: List[str] = None,71        PaginationConfig: PaginatorConfigTypeDef = None72    ) -> Iterator[GetResourcesOutputTypeDef]:73        """74        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetResources.paginate)75        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#getresourcespaginator)76        """77class GetTagKeysPaginator(Boto3Paginator):78    """79    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagKeys)80    [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagkeyspaginator)81    """82    def paginate(83        self, *, PaginationConfig: PaginatorConfigTypeDef = None84    ) -> Iterator[GetTagKeysOutputTypeDef]:85        """86        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagKeys.paginate)87        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagkeyspaginator)88        """89class GetTagValuesPaginator(Boto3Paginator):90    """91    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagValues)92    [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagvaluespaginator)93    """94    def paginate(95        self, *, Key: str, PaginationConfig: PaginatorConfigTypeDef = None96    ) -> Iterator[GetTagValuesOutputTypeDef]:97        """98        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.24.58/reference/services/resourcegroupstaggingapi.html#ResourceGroupsTaggingAPI.Paginator.GetTagValues.paginate)99        [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_resourcegroupstaggingapi/paginators.html#gettagvaluespaginator)...

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.