Typed dictionaries#
Index > ResourceGroupsTaggingAPI > Typed dictionaries
Auto-generated documentation for ResourceGroupsTaggingAPI type annotations stubs module mypy-boto3-resourcegroupstaggingapi.
ComplianceDetailsTypeDef#
# ComplianceDetailsTypeDef 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],
DescribeReportCreationOutputTypeDef#
# DescribeReportCreationOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import DescribeReportCreationOutputTypeDef
def get_value() -> DescribeReportCreationOutputTypeDef:
return {
"Status": ...,
"S3Location": ...,
"ErrorMessage": ...,
"ResponseMetadata": ...,
}
# DescribeReportCreationOutputTypeDef definition
class DescribeReportCreationOutputTypeDef(TypedDict):
Status: str,
S3Location: str,
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
FailureInfoTypeDef#
# FailureInfoTypeDef 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
GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef#
# GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef
def get_value() -> GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef:
return {
"TargetIdFilters": ...,
}
# GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef definition
class GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef(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)
GetComplianceSummaryInputRequestTypeDef#
# GetComplianceSummaryInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputRequestTypeDef
def get_value() -> GetComplianceSummaryInputRequestTypeDef:
return {
"TargetIdFilters": ...,
}
# GetComplianceSummaryInputRequestTypeDef definition
class GetComplianceSummaryInputRequestTypeDef(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],
SummaryTypeDef#
# SummaryTypeDef 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 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]],
GetTagKeysInputGetTagKeysPaginateTypeDef#
# GetTagKeysInputGetTagKeysPaginateTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputGetTagKeysPaginateTypeDef
def get_value() -> GetTagKeysInputGetTagKeysPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# GetTagKeysInputGetTagKeysPaginateTypeDef definition
class GetTagKeysInputGetTagKeysPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTagKeysInputRequestTypeDef#
# GetTagKeysInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputRequestTypeDef
def get_value() -> GetTagKeysInputRequestTypeDef:
return {
"PaginationToken": ...,
}
# GetTagKeysInputRequestTypeDef definition
class GetTagKeysInputRequestTypeDef(TypedDict):
PaginationToken: NotRequired[str],
GetTagKeysOutputTypeDef#
# GetTagKeysOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysOutputTypeDef
def get_value() -> GetTagKeysOutputTypeDef:
return {
"PaginationToken": ...,
"TagKeys": ...,
"ResponseMetadata": ...,
}
# GetTagKeysOutputTypeDef definition
class GetTagKeysOutputTypeDef(TypedDict):
PaginationToken: str,
TagKeys: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTagValuesInputGetTagValuesPaginateTypeDef#
# GetTagValuesInputGetTagValuesPaginateTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputGetTagValuesPaginateTypeDef
def get_value() -> GetTagValuesInputGetTagValuesPaginateTypeDef:
return {
"Key": ...,
}
# GetTagValuesInputGetTagValuesPaginateTypeDef definition
class GetTagValuesInputGetTagValuesPaginateTypeDef(TypedDict):
Key: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTagValuesInputRequestTypeDef#
# GetTagValuesInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputRequestTypeDef
def get_value() -> GetTagValuesInputRequestTypeDef:
return {
"Key": ...,
}
# GetTagValuesInputRequestTypeDef definition
class GetTagValuesInputRequestTypeDef(TypedDict):
Key: str,
PaginationToken: NotRequired[str],
GetTagValuesOutputTypeDef#
# GetTagValuesOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesOutputTypeDef
def get_value() -> GetTagValuesOutputTypeDef:
return {
"PaginationToken": ...,
"TagValues": ...,
"ResponseMetadata": ...,
}
# GetTagValuesOutputTypeDef definition
class GetTagValuesOutputTypeDef(TypedDict):
PaginationToken: str,
TagValues: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef 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],
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartReportCreationInputRequestTypeDef#
# StartReportCreationInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import StartReportCreationInputRequestTypeDef
def get_value() -> StartReportCreationInputRequestTypeDef:
return {
"S3Bucket": ...,
}
# StartReportCreationInputRequestTypeDef definition
class StartReportCreationInputRequestTypeDef(TypedDict):
S3Bucket: str,
TagResourcesInputRequestTypeDef#
# TagResourcesInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesInputRequestTypeDef
def get_value() -> TagResourcesInputRequestTypeDef:
return {
"ResourceARNList": ...,
"Tags": ...,
}
# TagResourcesInputRequestTypeDef definition
class TagResourcesInputRequestTypeDef(TypedDict):
ResourceARNList: Sequence[str],
Tags: Mapping[str, str],
UntagResourcesInputRequestTypeDef#
# UntagResourcesInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesInputRequestTypeDef
def get_value() -> UntagResourcesInputRequestTypeDef:
return {
"ResourceARNList": ...,
"TagKeys": ...,
}
# UntagResourcesInputRequestTypeDef definition
class UntagResourcesInputRequestTypeDef(TypedDict):
ResourceARNList: Sequence[str],
TagKeys: Sequence[str],
TagResourcesOutputTypeDef#
# TagResourcesOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesOutputTypeDef
def get_value() -> TagResourcesOutputTypeDef:
return {
"FailedResourcesMap": ...,
"ResponseMetadata": ...,
}
# TagResourcesOutputTypeDef definition
class TagResourcesOutputTypeDef(TypedDict):
FailedResourcesMap: Dict[str, FailureInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UntagResourcesOutputTypeDef#
# UntagResourcesOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesOutputTypeDef
def get_value() -> UntagResourcesOutputTypeDef:
return {
"FailedResourcesMap": ...,
"ResponseMetadata": ...,
}
# UntagResourcesOutputTypeDef definition
class UntagResourcesOutputTypeDef(TypedDict):
FailedResourcesMap: Dict[str, FailureInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetComplianceSummaryOutputTypeDef#
# GetComplianceSummaryOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryOutputTypeDef
def get_value() -> GetComplianceSummaryOutputTypeDef:
return {
"SummaryList": ...,
"PaginationToken": ...,
"ResponseMetadata": ...,
}
# GetComplianceSummaryOutputTypeDef definition
class GetComplianceSummaryOutputTypeDef(TypedDict):
SummaryList: List[SummaryTypeDef], # (1)
PaginationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetResourcesInputGetResourcesPaginateTypeDef#
# GetResourcesInputGetResourcesPaginateTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputGetResourcesPaginateTypeDef
def get_value() -> GetResourcesInputGetResourcesPaginateTypeDef:
return {
"TagFilters": ...,
}
# GetResourcesInputGetResourcesPaginateTypeDef definition
class GetResourcesInputGetResourcesPaginateTypeDef(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)
GetResourcesInputRequestTypeDef#
# GetResourcesInputRequestTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputRequestTypeDef
def get_value() -> GetResourcesInputRequestTypeDef:
return {
"PaginationToken": ...,
}
# GetResourcesInputRequestTypeDef definition
class GetResourcesInputRequestTypeDef(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 TagFilterTypeDef
ResourceTagMappingTypeDef#
# ResourceTagMappingTypeDef 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 TagTypeDef
- See ComplianceDetailsTypeDef
GetResourcesOutputTypeDef#
# GetResourcesOutputTypeDef usage example
from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesOutputTypeDef
def get_value() -> GetResourcesOutputTypeDef:
return {
"PaginationToken": ...,
"ResourceTagMappingList": ...,
"ResponseMetadata": ...,
}
# GetResourcesOutputTypeDef definition
class GetResourcesOutputTypeDef(TypedDict):
PaginationToken: str,
ResourceTagMappingList: List[ResourceTagMappingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)