Skip to content

Type definitions#

Index > ResourceGroups > Type definitions

Auto-generated documentation for ResourceGroups type annotations stubs module mypy-boto3-resource-groups.

AccountSettingsTypeDef#

# AccountSettingsTypeDef definition

class AccountSettingsTypeDef(TypedDict):
    GroupLifecycleEventsDesiredStatus: NotRequired[GroupLifecycleEventsDesiredStatusType],  # (1)
    GroupLifecycleEventsStatus: NotRequired[GroupLifecycleEventsStatusType],  # (2)
    GroupLifecycleEventsStatusMessage: NotRequired[str],
  1. See GroupLifecycleEventsDesiredStatusType
  2. See GroupLifecycleEventsStatusType

ResourceQueryTypeDef#

# ResourceQueryTypeDef definition

class ResourceQueryTypeDef(TypedDict):
    Type: QueryTypeType,  # (1)
    Query: str,
  1. See QueryTypeType

GroupTypeDef#

# GroupTypeDef definition

class GroupTypeDef(TypedDict):
    GroupArn: str,
    Name: str,
    Description: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteGroupInputRequestTypeDef#

# DeleteGroupInputRequestTypeDef definition

class DeleteGroupInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],

FailedResourceTypeDef#

# FailedResourceTypeDef definition

class FailedResourceTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    ErrorMessage: NotRequired[str],
    ErrorCode: NotRequired[str],

GetGroupConfigurationInputRequestTypeDef#

# GetGroupConfigurationInputRequestTypeDef definition

class GetGroupConfigurationInputRequestTypeDef(TypedDict):
    Group: NotRequired[str],

GetGroupInputRequestTypeDef#

# GetGroupInputRequestTypeDef definition

class GetGroupInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],

GetGroupQueryInputRequestTypeDef#

# GetGroupQueryInputRequestTypeDef definition

class GetGroupQueryInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],

GetTagsInputRequestTypeDef#

# GetTagsInputRequestTypeDef definition

class GetTagsInputRequestTypeDef(TypedDict):
    Arn: str,

GroupConfigurationParameterTypeDef#

# GroupConfigurationParameterTypeDef definition

class GroupConfigurationParameterTypeDef(TypedDict):
    Name: str,
    Values: NotRequired[Sequence[str]],

GroupFilterTypeDef#

# GroupFilterTypeDef definition

class GroupFilterTypeDef(TypedDict):
    Name: GroupFilterNameType,  # (1)
    Values: Sequence[str],
  1. See GroupFilterNameType

GroupIdentifierTypeDef#

# GroupIdentifierTypeDef definition

class GroupIdentifierTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupArn: NotRequired[str],

GroupResourcesInputRequestTypeDef#

# GroupResourcesInputRequestTypeDef definition

class GroupResourcesInputRequestTypeDef(TypedDict):
    Group: str,
    ResourceArns: Sequence[str],

PendingResourceTypeDef#

# PendingResourceTypeDef definition

class PendingResourceTypeDef(TypedDict):
    ResourceArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ResourceFilterTypeDef#

# ResourceFilterTypeDef definition

class ResourceFilterTypeDef(TypedDict):
    Name: ResourceFilterNameType,  # (1)
    Values: Sequence[str],
  1. See ResourceFilterNameType

ResourceIdentifierTypeDef#

# ResourceIdentifierTypeDef definition

class ResourceIdentifierTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    ResourceType: NotRequired[str],

ResourceStatusTypeDef#

# ResourceStatusTypeDef definition

class ResourceStatusTypeDef(TypedDict):
    Name: NotRequired[ResourceStatusValueType],  # (1)
  1. See ResourceStatusValueType

QueryErrorTypeDef#

# QueryErrorTypeDef definition

class QueryErrorTypeDef(TypedDict):
    ErrorCode: NotRequired[QueryErrorCodeType],  # (1)
    Message: NotRequired[str],
  1. See QueryErrorCodeType

TagInputRequestTypeDef#

# TagInputRequestTypeDef definition

class TagInputRequestTypeDef(TypedDict):
    Arn: str,
    Tags: Mapping[str, str],

UngroupResourcesInputRequestTypeDef#

# UngroupResourcesInputRequestTypeDef definition

class UngroupResourcesInputRequestTypeDef(TypedDict):
    Group: str,
    ResourceArns: Sequence[str],

UntagInputRequestTypeDef#

# UntagInputRequestTypeDef definition

class UntagInputRequestTypeDef(TypedDict):
    Arn: str,
    Keys: Sequence[str],

UpdateAccountSettingsInputRequestTypeDef#

# UpdateAccountSettingsInputRequestTypeDef definition

class UpdateAccountSettingsInputRequestTypeDef(TypedDict):
    GroupLifecycleEventsDesiredStatus: NotRequired[GroupLifecycleEventsDesiredStatusType],  # (1)
  1. See GroupLifecycleEventsDesiredStatusType

UpdateGroupInputRequestTypeDef#

# UpdateGroupInputRequestTypeDef definition

class UpdateGroupInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],
    Description: NotRequired[str],

GroupQueryTypeDef#

# GroupQueryTypeDef definition

class GroupQueryTypeDef(TypedDict):
    GroupName: str,
    ResourceQuery: ResourceQueryTypeDef,  # (1)
  1. See ResourceQueryTypeDef

SearchResourcesInputRequestTypeDef#

# SearchResourcesInputRequestTypeDef definition

class SearchResourcesInputRequestTypeDef(TypedDict):
    ResourceQuery: ResourceQueryTypeDef,  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ResourceQueryTypeDef

UpdateGroupQueryInputRequestTypeDef#

# UpdateGroupQueryInputRequestTypeDef definition

class UpdateGroupQueryInputRequestTypeDef(TypedDict):
    ResourceQuery: ResourceQueryTypeDef,  # (1)
    GroupName: NotRequired[str],
    Group: NotRequired[str],
  1. See ResourceQueryTypeDef

DeleteGroupOutputTypeDef#

# DeleteGroupOutputTypeDef definition

class DeleteGroupOutputTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GetAccountSettingsOutputTypeDef#

# GetAccountSettingsOutputTypeDef definition

class GetAccountSettingsOutputTypeDef(TypedDict):
    AccountSettings: AccountSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountSettingsTypeDef
  2. See ResponseMetadataTypeDef

GetGroupOutputTypeDef#

# GetGroupOutputTypeDef definition

class GetGroupOutputTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GetTagsOutputTypeDef#

# GetTagsOutputTypeDef definition

class GetTagsOutputTypeDef(TypedDict):
    Arn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagOutputTypeDef#

# TagOutputTypeDef definition

class TagOutputTypeDef(TypedDict):
    Arn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UntagOutputTypeDef#

# UntagOutputTypeDef definition

class UntagOutputTypeDef(TypedDict):
    Arn: str,
    Keys: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAccountSettingsOutputTypeDef#

# UpdateAccountSettingsOutputTypeDef definition

class UpdateAccountSettingsOutputTypeDef(TypedDict):
    AccountSettings: AccountSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateGroupOutputTypeDef#

# UpdateGroupOutputTypeDef definition

class UpdateGroupOutputTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GroupConfigurationItemTypeDef#

# GroupConfigurationItemTypeDef definition

class GroupConfigurationItemTypeDef(TypedDict):
    Type: str,
    Parameters: NotRequired[Sequence[GroupConfigurationParameterTypeDef]],  # (1)
  1. See GroupConfigurationParameterTypeDef

ListGroupsInputRequestTypeDef#

# ListGroupsInputRequestTypeDef definition

class ListGroupsInputRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[GroupFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See GroupFilterTypeDef

ListGroupsOutputTypeDef#

# ListGroupsOutputTypeDef definition

class ListGroupsOutputTypeDef(TypedDict):
    GroupIdentifiers: List[GroupIdentifierTypeDef],  # (1)
    Groups: List[GroupTypeDef],  # (2)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GroupIdentifierTypeDef
  2. See GroupTypeDef
  3. See ResponseMetadataTypeDef

GroupResourcesOutputTypeDef#

# GroupResourcesOutputTypeDef definition

class GroupResourcesOutputTypeDef(TypedDict):
    Succeeded: List[str],
    Failed: List[FailedResourceTypeDef],  # (1)
    Pending: List[PendingResourceTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedResourceTypeDef
  2. See PendingResourceTypeDef
  3. See ResponseMetadataTypeDef

UngroupResourcesOutputTypeDef#

# UngroupResourcesOutputTypeDef definition

class UngroupResourcesOutputTypeDef(TypedDict):
    Succeeded: List[str],
    Failed: List[FailedResourceTypeDef],  # (1)
    Pending: List[PendingResourceTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedResourceTypeDef
  2. See PendingResourceTypeDef
  3. See ResponseMetadataTypeDef

ListGroupsInputListGroupsPaginateTypeDef#

# ListGroupsInputListGroupsPaginateTypeDef definition

class ListGroupsInputListGroupsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[GroupFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See GroupFilterTypeDef
  2. See PaginatorConfigTypeDef

SearchResourcesInputSearchResourcesPaginateTypeDef#

# SearchResourcesInputSearchResourcesPaginateTypeDef definition

class SearchResourcesInputSearchResourcesPaginateTypeDef(TypedDict):
    ResourceQuery: ResourceQueryTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ResourceQueryTypeDef
  2. See PaginatorConfigTypeDef

ListGroupResourcesInputListGroupResourcesPaginateTypeDef#

# ListGroupResourcesInputListGroupResourcesPaginateTypeDef definition

class ListGroupResourcesInputListGroupResourcesPaginateTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],
    Filters: NotRequired[Sequence[ResourceFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ResourceFilterTypeDef
  2. See PaginatorConfigTypeDef

ListGroupResourcesInputRequestTypeDef#

# ListGroupResourcesInputRequestTypeDef definition

class ListGroupResourcesInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    Group: NotRequired[str],
    Filters: NotRequired[Sequence[ResourceFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ResourceFilterTypeDef

ListGroupResourcesItemTypeDef#

# ListGroupResourcesItemTypeDef definition

class ListGroupResourcesItemTypeDef(TypedDict):
    Identifier: NotRequired[ResourceIdentifierTypeDef],  # (1)
    Status: NotRequired[ResourceStatusTypeDef],  # (2)
  1. See ResourceIdentifierTypeDef
  2. See ResourceStatusTypeDef

SearchResourcesOutputTypeDef#

# SearchResourcesOutputTypeDef definition

class SearchResourcesOutputTypeDef(TypedDict):
    ResourceIdentifiers: List[ResourceIdentifierTypeDef],  # (1)
    NextToken: str,
    QueryErrors: List[QueryErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ResourceIdentifierTypeDef
  2. See QueryErrorTypeDef
  3. See ResponseMetadataTypeDef

GetGroupQueryOutputTypeDef#

# GetGroupQueryOutputTypeDef definition

class GetGroupQueryOutputTypeDef(TypedDict):
    GroupQuery: GroupQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupQueryTypeDef
  2. See ResponseMetadataTypeDef

UpdateGroupQueryOutputTypeDef#

# UpdateGroupQueryOutputTypeDef definition

class UpdateGroupQueryOutputTypeDef(TypedDict):
    GroupQuery: GroupQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupQueryTypeDef
  2. See ResponseMetadataTypeDef

CreateGroupInputRequestTypeDef#

# CreateGroupInputRequestTypeDef definition

class CreateGroupInputRequestTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],
    ResourceQuery: NotRequired[ResourceQueryTypeDef],  # (1)
    Tags: NotRequired[Mapping[str, str]],
    Configuration: NotRequired[Sequence[GroupConfigurationItemTypeDef]],  # (2)
  1. See ResourceQueryTypeDef
  2. See GroupConfigurationItemTypeDef

GroupConfigurationTypeDef#

# GroupConfigurationTypeDef definition

class GroupConfigurationTypeDef(TypedDict):
    Configuration: NotRequired[List[GroupConfigurationItemTypeDef]],  # (1)
    ProposedConfiguration: NotRequired[List[GroupConfigurationItemTypeDef]],  # (1)
    Status: NotRequired[GroupConfigurationStatusType],  # (3)
    FailureReason: NotRequired[str],
  1. See GroupConfigurationItemTypeDef
  2. See GroupConfigurationItemTypeDef
  3. See GroupConfigurationStatusType

PutGroupConfigurationInputRequestTypeDef#

# PutGroupConfigurationInputRequestTypeDef definition

class PutGroupConfigurationInputRequestTypeDef(TypedDict):
    Group: NotRequired[str],
    Configuration: NotRequired[Sequence[GroupConfigurationItemTypeDef]],  # (1)
  1. See GroupConfigurationItemTypeDef

ListGroupResourcesOutputTypeDef#

# ListGroupResourcesOutputTypeDef definition

class ListGroupResourcesOutputTypeDef(TypedDict):
    Resources: List[ListGroupResourcesItemTypeDef],  # (1)
    ResourceIdentifiers: List[ResourceIdentifierTypeDef],  # (2)
    NextToken: str,
    QueryErrors: List[QueryErrorTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ListGroupResourcesItemTypeDef
  2. See ResourceIdentifierTypeDef
  3. See QueryErrorTypeDef
  4. See ResponseMetadataTypeDef

CreateGroupOutputTypeDef#

# CreateGroupOutputTypeDef definition

class CreateGroupOutputTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResourceQuery: ResourceQueryTypeDef,  # (2)
    Tags: Dict[str, str],
    GroupConfiguration: GroupConfigurationTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See GroupTypeDef
  2. See ResourceQueryTypeDef
  3. See GroupConfigurationTypeDef
  4. See ResponseMetadataTypeDef

GetGroupConfigurationOutputTypeDef#

# GetGroupConfigurationOutputTypeDef definition

class GetGroupConfigurationOutputTypeDef(TypedDict):
    GroupConfiguration: GroupConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupConfigurationTypeDef
  2. See ResponseMetadataTypeDef