Typed dictionaries

Index > ResourceGroupsTaggingAPI > Typed dictionaries

Auto-generated documentation for ResourceGroupsTaggingAPI type annotations stubs module mypy-boto3-resourcegroupstaggingapi.

ComplianceDetailsTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import ComplianceDetailsTypeDef

def get_value() -> ComplianceDetailsTypeDef:
    return {
        "NoncompliantKeys": ...,
    }

Definition

class ComplianceDetailsTypeDef(TypedDict):
    NoncompliantKeys: NotRequired[List[str]],
    KeysWithNoncompliantValues: NotRequired[List[str]],
    ComplianceStatus: NotRequired[bool],

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

FailureInfoTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import FailureInfoTypeDef

def get_value() -> FailureInfoTypeDef:
    return {
        "StatusCode": ...,
    }

Definition

class FailureInfoTypeDef(TypedDict):
    StatusCode: NotRequired[int],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],

1. See ErrorCodeType

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetComplianceSummaryInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputRequestTypeDef

def get_value() -> GetComplianceSummaryInputRequestTypeDef:
    return {
        "TargetIdFilters": ...,
    }

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],

1. See GroupByAttributeType

SummaryTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import SummaryTypeDef

def get_value() -> SummaryTypeDef:
    return {
        "LastUpdated": ...,
    }

Definition

class SummaryTypeDef(TypedDict):
    LastUpdated: NotRequired[str],
    TargetId: NotRequired[str],
    TargetIdType: NotRequired[TargetIdTypeType],  # (1)
    Region: NotRequired[str],
    ResourceType: NotRequired[str],
    NonCompliantResources: NotRequired[int],

1. See TargetIdTypeType

TagFilterTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import TagFilterTypeDef

def get_value() -> TagFilterTypeDef:
    return {
        "Key": ...,
    }

Definition

class TagFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

GetTagKeysInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputRequestTypeDef

def get_value() -> GetTagKeysInputRequestTypeDef:
    return {
        "PaginationToken": ...,
    }

Definition

class GetTagKeysInputRequestTypeDef(TypedDict):
    PaginationToken: NotRequired[str],

GetTagValuesInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputRequestTypeDef

def get_value() -> GetTagValuesInputRequestTypeDef:
    return {
        "Key": ...,
    }

Definition

class GetTagValuesInputRequestTypeDef(TypedDict):
    Key: str,
    PaginationToken: NotRequired[str],

TagTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

StartReportCreationInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import StartReportCreationInputRequestTypeDef

def get_value() -> StartReportCreationInputRequestTypeDef:
    return {
        "S3Bucket": ...,
    }

Definition

class StartReportCreationInputRequestTypeDef(TypedDict):
    S3Bucket: str,

TagResourcesInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesInputRequestTypeDef

def get_value() -> TagResourcesInputRequestTypeDef:
    return {
        "ResourceARNList": ...,
        "Tags": ...,
    }

Definition

class TagResourcesInputRequestTypeDef(TypedDict):
    ResourceARNList: Sequence[str],
    Tags: Mapping[str, str],

UntagResourcesInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesInputRequestTypeDef

def get_value() -> UntagResourcesInputRequestTypeDef:
    return {
        "ResourceARNList": ...,
        "TagKeys": ...,
    }

Definition

class UntagResourcesInputRequestTypeDef(TypedDict):
    ResourceARNList: Sequence[str],
    TagKeys: Sequence[str],

DescribeReportCreationOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import DescribeReportCreationOutputTypeDef

def get_value() -> DescribeReportCreationOutputTypeDef:
    return {
        "Status": ...,
        "S3Location": ...,
        "ErrorMessage": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeReportCreationOutputTypeDef(TypedDict):
    Status: str,
    S3Location: str,
    ErrorMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetTagKeysOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysOutputTypeDef

def get_value() -> GetTagKeysOutputTypeDef:
    return {
        "PaginationToken": ...,
        "TagKeys": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetTagKeysOutputTypeDef(TypedDict):
    PaginationToken: str,
    TagKeys: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetTagValuesOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesOutputTypeDef

def get_value() -> GetTagValuesOutputTypeDef:
    return {
        "PaginationToken": ...,
        "TagValues": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetTagValuesOutputTypeDef(TypedDict):
    PaginationToken: str,
    TagValues: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

TagResourcesOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesOutputTypeDef

def get_value() -> TagResourcesOutputTypeDef:
    return {
        "FailedResourcesMap": ...,
        "ResponseMetadata": ...,
    }

Definition

class TagResourcesOutputTypeDef(TypedDict):
    FailedResourcesMap: Dict[str, FailureInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FailureInfoTypeDef
2. See ResponseMetadataTypeDef

UntagResourcesOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import UntagResourcesOutputTypeDef

def get_value() -> UntagResourcesOutputTypeDef:
    return {
        "FailedResourcesMap": ...,
        "ResponseMetadata": ...,
    }

Definition

class UntagResourcesOutputTypeDef(TypedDict):
    FailedResourcesMap: Dict[str, FailureInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FailureInfoTypeDef
2. See ResponseMetadataTypeDef

GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef

def get_value() -> GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef:
    return {
        "TargetIdFilters": ...,
    }

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)

1. See GroupByAttributeType
2. See PaginatorConfigTypeDef

GetTagKeysInputGetTagKeysPaginateTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagKeysInputGetTagKeysPaginateTypeDef

def get_value() -> GetTagKeysInputGetTagKeysPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class GetTagKeysInputGetTagKeysPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetTagValuesInputGetTagValuesPaginateTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetTagValuesInputGetTagValuesPaginateTypeDef

def get_value() -> GetTagValuesInputGetTagValuesPaginateTypeDef:
    return {
        "Key": ...,
    }

Definition

class GetTagValuesInputGetTagValuesPaginateTypeDef(TypedDict):
    Key: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetComplianceSummaryOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetComplianceSummaryOutputTypeDef

def get_value() -> GetComplianceSummaryOutputTypeDef:
    return {
        "SummaryList": ...,
        "PaginationToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetComplianceSummaryOutputTypeDef(TypedDict):
    SummaryList: List[SummaryTypeDef],  # (1)
    PaginationToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SummaryTypeDef
2. See ResponseMetadataTypeDef

GetResourcesInputGetResourcesPaginateTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputGetResourcesPaginateTypeDef

def get_value() -> GetResourcesInputGetResourcesPaginateTypeDef:
    return {
        "TagFilters": ...,
    }

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)

1. See TagFilterTypeDef
2. See PaginatorConfigTypeDef

GetResourcesInputRequestTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesInputRequestTypeDef

def get_value() -> GetResourcesInputRequestTypeDef:
    return {
        "PaginationToken": ...,
    }

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]],

1. See TagFilterTypeDef

ResourceTagMappingTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import ResourceTagMappingTypeDef

def get_value() -> ResourceTagMappingTypeDef:
    return {
        "ResourceARN": ...,
    }

Definition

class ResourceTagMappingTypeDef(TypedDict):
    ResourceARN: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    ComplianceDetails: NotRequired[ComplianceDetailsTypeDef],  # (2)

1. See TagTypeDef
2. See ComplianceDetailsTypeDef

GetResourcesOutputTypeDef

Usage Example

from mypy_boto3_resourcegroupstaggingapi.type_defs import GetResourcesOutputTypeDef

def get_value() -> GetResourcesOutputTypeDef:
    return {
        "PaginationToken": ...,
        "ResourceTagMappingList": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetResourcesOutputTypeDef(TypedDict):
    PaginationToken: str,
    ResourceTagMappingList: List[ResourceTagMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceTagMappingTypeDef
2. See ResponseMetadataTypeDef