Type definitions#
Index > ResourceGroupsTaggingAPI > Type definitions
Auto-generated documentation for ResourceGroupsTaggingAPI type annotations stubs module mypy-boto3-resourcegroupstaggingapi.
ComplianceDetailsTypeDef#
# ComplianceDetailsTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import ComplianceDetailsTypeDef
def get_value() -> ComplianceDetailsTypeDef:
return {
"NoncompliantKeys": ...,
}
# ComplianceDetailsTypeDef definition
class ComplianceDetailsTypeDef(TypedDict):
NoncompliantKeys: NotRequired[List[str]],
KeysWithNoncompliantValues: NotRequired[List[str]],
ComplianceStatus: NotRequired[bool],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
FailureInfoTypeDef#
# FailureInfoTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import FailureInfoTypeDef
def get_value() -> FailureInfoTypeDef:
return {
"StatusCode": ...,
}
# FailureInfoTypeDef definition
class FailureInfoTypeDef(TypedDict):
StatusCode: NotRequired[int],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
- See ErrorCodeType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetComplianceSummaryInputTypeDef#
# GetComplianceSummaryInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputTypeDef
def get_value() -> GetComplianceSummaryInputTypeDef:
return {
"TargetIdFilters": ...,
}
# GetComplianceSummaryInputTypeDef definition
class GetComplianceSummaryInputTypeDef(TypedDict):
TargetIdFilters: NotRequired[Sequence[str]],
RegionFilters: NotRequired[Sequence[str]],
ResourceTypeFilters: NotRequired[Sequence[str]],
TagKeyFilters: NotRequired[Sequence[str]],
GroupBy: NotRequired[Sequence[GroupByAttributeType]], # (1)
MaxResults: NotRequired[int],
PaginationToken: NotRequired[str],
- See
Sequence[GroupByAttributeType]
SummaryTypeDef#
# SummaryTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import SummaryTypeDef
def get_value() -> SummaryTypeDef:
return {
"LastUpdated": ...,
}
# SummaryTypeDef definition
class SummaryTypeDef(TypedDict):
LastUpdated: NotRequired[str],
TargetId: NotRequired[str],
TargetIdType: NotRequired[TargetIdTypeType], # (1)
Region: NotRequired[str],
ResourceType: NotRequired[str],
NonCompliantResources: NotRequired[int],
- See TargetIdTypeType
TagFilterTypeDef#
# TagFilterTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagFilterTypeDef
def get_value() -> TagFilterTypeDef:
return {
"Key": ...,
}
# TagFilterTypeDef definition
class TagFilterTypeDef(TypedDict):
Key: NotRequired[str],
Values: NotRequired[Sequence[str]],
GetTagKeysInputTypeDef#
# GetTagKeysInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputTypeDef
def get_value() -> GetTagKeysInputTypeDef:
return {
"PaginationToken": ...,
}
# GetTagKeysInputTypeDef definition
class GetTagKeysInputTypeDef(TypedDict):
PaginationToken: NotRequired[str],
GetTagValuesInputTypeDef#
# GetTagValuesInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputTypeDef
def get_value() -> GetTagValuesInputTypeDef:
return {
"Key": ...,
}
# GetTagValuesInputTypeDef definition
class GetTagValuesInputTypeDef(TypedDict):
Key: str,
PaginationToken: NotRequired[str],
TagTypeDef#
# TagTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
StartReportCreationInputTypeDef#
# StartReportCreationInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import StartReportCreationInputTypeDef
def get_value() -> StartReportCreationInputTypeDef:
return {
"S3Bucket": ...,
}
# StartReportCreationInputTypeDef definition
class StartReportCreationInputTypeDef(TypedDict):
S3Bucket: str,
TagResourcesInputTypeDef#
# TagResourcesInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesInputTypeDef
def get_value() -> TagResourcesInputTypeDef:
return {
"ResourceARNList": ...,
}
# TagResourcesInputTypeDef definition
class TagResourcesInputTypeDef(TypedDict):
ResourceARNList: Sequence[str],
Tags: Mapping[str, str],
UntagResourcesInputTypeDef#
# UntagResourcesInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesInputTypeDef
def get_value() -> UntagResourcesInputTypeDef:
return {
"ResourceARNList": ...,
}
# UntagResourcesInputTypeDef definition
class UntagResourcesInputTypeDef(TypedDict):
ResourceARNList: Sequence[str],
TagKeys: Sequence[str],
DescribeReportCreationOutputTypeDef#
# DescribeReportCreationOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import DescribeReportCreationOutputTypeDef
def get_value() -> DescribeReportCreationOutputTypeDef:
return {
"Status": ...,
}
# DescribeReportCreationOutputTypeDef definition
class DescribeReportCreationOutputTypeDef(TypedDict):
Status: str,
S3Location: str,
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTagKeysOutputTypeDef#
# GetTagKeysOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysOutputTypeDef
def get_value() -> GetTagKeysOutputTypeDef:
return {
"PaginationToken": ...,
}
# GetTagKeysOutputTypeDef definition
class GetTagKeysOutputTypeDef(TypedDict):
TagKeys: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PaginationToken: NotRequired[str],
GetTagValuesOutputTypeDef#
# GetTagValuesOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesOutputTypeDef
def get_value() -> GetTagValuesOutputTypeDef:
return {
"PaginationToken": ...,
}
# GetTagValuesOutputTypeDef definition
class GetTagValuesOutputTypeDef(TypedDict):
TagValues: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PaginationToken: NotRequired[str],
TagResourcesOutputTypeDef#
# TagResourcesOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesOutputTypeDef
def get_value() -> TagResourcesOutputTypeDef:
return {
"FailedResourcesMap": ...,
}
# TagResourcesOutputTypeDef definition
class TagResourcesOutputTypeDef(TypedDict):
FailedResourcesMap: Dict[str, FailureInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
Dict[str, FailureInfoTypeDef]
- See ResponseMetadataTypeDef
UntagResourcesOutputTypeDef#
# UntagResourcesOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesOutputTypeDef
def get_value() -> UntagResourcesOutputTypeDef:
return {
"FailedResourcesMap": ...,
}
# UntagResourcesOutputTypeDef definition
class UntagResourcesOutputTypeDef(TypedDict):
FailedResourcesMap: Dict[str, FailureInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
Dict[str, FailureInfoTypeDef]
- See ResponseMetadataTypeDef
GetComplianceSummaryInputPaginateTypeDef#
# GetComplianceSummaryInputPaginateTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputPaginateTypeDef
def get_value() -> GetComplianceSummaryInputPaginateTypeDef:
return {
"TargetIdFilters": ...,
}
# GetComplianceSummaryInputPaginateTypeDef definition
class GetComplianceSummaryInputPaginateTypeDef(TypedDict):
TargetIdFilters: NotRequired[Sequence[str]],
RegionFilters: NotRequired[Sequence[str]],
ResourceTypeFilters: NotRequired[Sequence[str]],
TagKeyFilters: NotRequired[Sequence[str]],
GroupBy: NotRequired[Sequence[GroupByAttributeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See
Sequence[GroupByAttributeType]
- See PaginatorConfigTypeDef
GetTagKeysInputPaginateTypeDef#
# GetTagKeysInputPaginateTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputPaginateTypeDef
def get_value() -> GetTagKeysInputPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# GetTagKeysInputPaginateTypeDef definition
class GetTagKeysInputPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTagValuesInputPaginateTypeDef#
# GetTagValuesInputPaginateTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputPaginateTypeDef
def get_value() -> GetTagValuesInputPaginateTypeDef:
return {
"Key": ...,
}
# GetTagValuesInputPaginateTypeDef definition
class GetTagValuesInputPaginateTypeDef(TypedDict):
Key: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetComplianceSummaryOutputTypeDef#
# GetComplianceSummaryOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryOutputTypeDef
def get_value() -> GetComplianceSummaryOutputTypeDef:
return {
"SummaryList": ...,
}
# GetComplianceSummaryOutputTypeDef definition
class GetComplianceSummaryOutputTypeDef(TypedDict):
SummaryList: List[SummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PaginationToken: NotRequired[str],
- See
List[SummaryTypeDef]
- See ResponseMetadataTypeDef
GetResourcesInputPaginateTypeDef#
# GetResourcesInputPaginateTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputPaginateTypeDef
def get_value() -> GetResourcesInputPaginateTypeDef:
return {
"TagFilters": ...,
}
# GetResourcesInputPaginateTypeDef definition
class GetResourcesInputPaginateTypeDef(TypedDict):
TagFilters: NotRequired[Sequence[TagFilterTypeDef]], # (1)
TagsPerPage: NotRequired[int],
ResourceTypeFilters: NotRequired[Sequence[str]],
IncludeComplianceDetails: NotRequired[bool],
ExcludeCompliantResources: NotRequired[bool],
ResourceARNList: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See
Sequence[TagFilterTypeDef]
- See PaginatorConfigTypeDef
GetResourcesInputTypeDef#
# GetResourcesInputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputTypeDef
def get_value() -> GetResourcesInputTypeDef:
return {
"PaginationToken": ...,
}
# GetResourcesInputTypeDef definition
class GetResourcesInputTypeDef(TypedDict):
PaginationToken: NotRequired[str],
TagFilters: NotRequired[Sequence[TagFilterTypeDef]], # (1)
ResourcesPerPage: NotRequired[int],
TagsPerPage: NotRequired[int],
ResourceTypeFilters: NotRequired[Sequence[str]],
IncludeComplianceDetails: NotRequired[bool],
ExcludeCompliantResources: NotRequired[bool],
ResourceARNList: NotRequired[Sequence[str]],
- See
Sequence[TagFilterTypeDef]
ResourceTagMappingTypeDef#
# ResourceTagMappingTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import ResourceTagMappingTypeDef
def get_value() -> ResourceTagMappingTypeDef:
return {
"ResourceARN": ...,
}
# ResourceTagMappingTypeDef definition
class ResourceTagMappingTypeDef(TypedDict):
ResourceARN: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)
ComplianceDetails: NotRequired[ComplianceDetailsTypeDef], # (2)
- See
List[TagTypeDef]
- See ComplianceDetailsTypeDef
GetResourcesOutputTypeDef#
# GetResourcesOutputTypeDef TypedDict usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesOutputTypeDef
def get_value() -> GetResourcesOutputTypeDef:
return {
"PaginationToken": ...,
}
# GetResourcesOutputTypeDef definition
class GetResourcesOutputTypeDef(TypedDict):
ResourceTagMappingList: List[ResourceTagMappingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PaginationToken: NotRequired[str],
- See
List[ResourceTagMappingTypeDef]
- See ResponseMetadataTypeDef