Skip to content

Type definitions#

Index > ResourceGroupsTaggingAPI > Type definitions

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

ComplianceDetailsTypeDef#

# ComplianceDetailsTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

FailureInfoTypeDef#

# FailureInfoTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetComplianceSummaryInputRequestTypeDef#

# 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],
  1. See GroupByAttributeType

SummaryTypeDef#

# SummaryTypeDef 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#

# TagFilterTypeDef definition

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

GetTagKeysInputRequestTypeDef#

# GetTagKeysInputRequestTypeDef definition

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

GetTagValuesInputRequestTypeDef#

# GetTagValuesInputRequestTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

StartReportCreationInputRequestTypeDef#

# StartReportCreationInputRequestTypeDef definition

class StartReportCreationInputRequestTypeDef(TypedDict):
    S3Bucket: str,

TagResourcesInputRequestTypeDef#

# TagResourcesInputRequestTypeDef definition

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

UntagResourcesInputRequestTypeDef#

# UntagResourcesInputRequestTypeDef definition

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

DescribeReportCreationOutputTypeDef#

# DescribeReportCreationOutputTypeDef definition

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

GetTagKeysOutputTypeDef#

# GetTagKeysOutputTypeDef definition

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

GetTagValuesOutputTypeDef#

# GetTagValuesOutputTypeDef definition

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

TagResourcesOutputTypeDef#

# TagResourcesOutputTypeDef definition

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

UntagResourcesOutputTypeDef#

# UntagResourcesOutputTypeDef definition

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

GetComplianceSummaryInputGetComplianceSummaryPaginateTypeDef#

# 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)
  1. See GroupByAttributeType
  2. See PaginatorConfigTypeDef

GetTagKeysInputGetTagKeysPaginateTypeDef#

# GetTagKeysInputGetTagKeysPaginateTypeDef definition

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

GetTagValuesInputGetTagValuesPaginateTypeDef#

# GetTagValuesInputGetTagValuesPaginateTypeDef definition

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

GetComplianceSummaryOutputTypeDef#

# GetComplianceSummaryOutputTypeDef definition

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

GetResourcesInputGetResourcesPaginateTypeDef#

# 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)
  1. See TagFilterTypeDef
  2. See PaginatorConfigTypeDef

GetResourcesInputRequestTypeDef#

# 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]],
  1. See TagFilterTypeDef

ResourceTagMappingTypeDef#

# ResourceTagMappingTypeDef definition

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

GetResourcesOutputTypeDef#

# GetResourcesOutputTypeDef definition

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