Type definitions#
Auto-generated documentation for WorkDocs type annotations stubs module types-aiobotocore-workdocs.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AbortDocumentVersionUploadRequestRequestTypeDef#
# AbortDocumentVersionUploadRequestRequestTypeDef definition
class AbortDocumentVersionUploadRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
ActivateUserRequestRequestTypeDef#
# ActivateUserRequestRequestTypeDef definition
class ActivateUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UserMetadataTypeDef#
# UserMetadataTypeDef definition
class UserMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Username: NotRequired[str],
GivenName: NotRequired[str],
Surname: NotRequired[str],
EmailAddress: NotRequired[str],
NotificationOptionsTypeDef#
# NotificationOptionsTypeDef definition
class NotificationOptionsTypeDef(TypedDict):
SendEmail: NotRequired[bool],
EmailMessage: NotRequired[str],
SharePrincipalTypeDef#
# SharePrincipalTypeDef definition
class SharePrincipalTypeDef(TypedDict):
Id: str,
Type: PrincipalTypeType, # (1)
Role: RoleTypeType, # (2)
- See PrincipalTypeType
- See RoleTypeType
ShareResultTypeDef#
# ShareResultTypeDef definition
class ShareResultTypeDef(TypedDict):
PrincipalId: NotRequired[str],
InviteePrincipalId: NotRequired[str],
Role: NotRequired[RoleTypeType], # (1)
Status: NotRequired[ShareStatusTypeType], # (2)
ShareId: NotRequired[str],
StatusMessage: NotRequired[str],
- See RoleTypeType
- See ShareStatusTypeType
CreateCommentRequestRequestTypeDef#
# CreateCommentRequestRequestTypeDef definition
class CreateCommentRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
Text: str,
AuthenticationToken: NotRequired[str],
ParentId: NotRequired[str],
ThreadId: NotRequired[str],
Visibility: NotRequired[CommentVisibilityTypeType], # (1)
NotifyCollaborators: NotRequired[bool],
CreateCustomMetadataRequestRequestTypeDef#
# CreateCustomMetadataRequestRequestTypeDef definition
class CreateCustomMetadataRequestRequestTypeDef(TypedDict):
ResourceId: str,
CustomMetadata: Mapping[str, str],
AuthenticationToken: NotRequired[str],
VersionId: NotRequired[str],
CreateFolderRequestRequestTypeDef#
# CreateFolderRequestRequestTypeDef definition
class CreateFolderRequestRequestTypeDef(TypedDict):
ParentFolderId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
FolderMetadataTypeDef#
# FolderMetadataTypeDef definition
class FolderMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
CreatorId: NotRequired[str],
ParentFolderId: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
Signature: NotRequired[str],
Labels: NotRequired[List[str]],
Size: NotRequired[int],
LatestVersionSize: NotRequired[int],
CreateLabelsRequestRequestTypeDef#
# CreateLabelsRequestRequestTypeDef definition
class CreateLabelsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Labels: Sequence[str],
AuthenticationToken: NotRequired[str],
CreateNotificationSubscriptionRequestRequestTypeDef#
# CreateNotificationSubscriptionRequestRequestTypeDef definition
class CreateNotificationSubscriptionRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Endpoint: str,
Protocol: SubscriptionProtocolTypeType, # (1)
SubscriptionType: SubscriptionTypeType, # (2)
SubscriptionTypeDef#
# SubscriptionTypeDef definition
class SubscriptionTypeDef(TypedDict):
SubscriptionId: NotRequired[str],
EndPoint: NotRequired[str],
Protocol: NotRequired[SubscriptionProtocolTypeType], # (1)
StorageRuleTypeTypeDef#
# StorageRuleTypeTypeDef definition
class StorageRuleTypeTypeDef(TypedDict):
StorageAllocatedInBytes: NotRequired[int],
StorageType: NotRequired[StorageTypeType], # (1)
- See StorageTypeType
DeactivateUserRequestRequestTypeDef#
# DeactivateUserRequestRequestTypeDef definition
class DeactivateUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
DeleteCommentRequestRequestTypeDef#
# DeleteCommentRequestRequestTypeDef definition
class DeleteCommentRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
CommentId: str,
AuthenticationToken: NotRequired[str],
DeleteCustomMetadataRequestRequestTypeDef#
# DeleteCustomMetadataRequestRequestTypeDef definition
class DeleteCustomMetadataRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
VersionId: NotRequired[str],
Keys: NotRequired[Sequence[str]],
DeleteAll: NotRequired[bool],
DeleteDocumentRequestRequestTypeDef#
# DeleteDocumentRequestRequestTypeDef definition
class DeleteDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
DeleteDocumentVersionRequestRequestTypeDef#
# DeleteDocumentVersionRequestRequestTypeDef definition
class DeleteDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
DeletePriorVersions: bool,
AuthenticationToken: NotRequired[str],
DeleteFolderContentsRequestRequestTypeDef#
# DeleteFolderContentsRequestRequestTypeDef definition
class DeleteFolderContentsRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
DeleteFolderRequestRequestTypeDef#
# DeleteFolderRequestRequestTypeDef definition
class DeleteFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
DeleteLabelsRequestRequestTypeDef#
# DeleteLabelsRequestRequestTypeDef definition
class DeleteLabelsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
Labels: NotRequired[Sequence[str]],
DeleteAll: NotRequired[bool],
DeleteNotificationSubscriptionRequestRequestTypeDef#
# DeleteNotificationSubscriptionRequestRequestTypeDef definition
class DeleteNotificationSubscriptionRequestRequestTypeDef(TypedDict):
SubscriptionId: str,
OrganizationId: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeCommentsRequestRequestTypeDef#
# DescribeCommentsRequestRequestTypeDef definition
class DescribeCommentsRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeDocumentVersionsRequestRequestTypeDef#
# DescribeDocumentVersionsRequestRequestTypeDef definition
class DescribeDocumentVersionsRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Marker: NotRequired[str],
Limit: NotRequired[int],
Include: NotRequired[str],
Fields: NotRequired[str],
DocumentVersionMetadataTypeDef#
# DocumentVersionMetadataTypeDef definition
class DocumentVersionMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
ContentType: NotRequired[str],
Size: NotRequired[int],
Signature: NotRequired[str],
Status: NotRequired[DocumentStatusTypeType], # (1)
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
ContentCreatedTimestamp: NotRequired[datetime],
ContentModifiedTimestamp: NotRequired[datetime],
CreatorId: NotRequired[str],
Thumbnail: NotRequired[Dict[DocumentThumbnailTypeType, str]], # (2)
Source: NotRequired[Dict[DocumentSourceTypeType, str]], # (3)
DescribeFolderContentsRequestRequestTypeDef#
# DescribeFolderContentsRequestRequestTypeDef definition
class DescribeFolderContentsRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Sort: NotRequired[ResourceSortTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Limit: NotRequired[int],
Marker: NotRequired[str],
Type: NotRequired[FolderContentTypeType], # (3)
Include: NotRequired[str],
- See ResourceSortTypeType
- See OrderTypeType
- See FolderContentTypeType
DescribeGroupsRequestRequestTypeDef#
# DescribeGroupsRequestRequestTypeDef definition
class DescribeGroupsRequestRequestTypeDef(TypedDict):
SearchQuery: str,
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
Marker: NotRequired[str],
Limit: NotRequired[int],
GroupMetadataTypeDef#
# GroupMetadataTypeDef definition
class GroupMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
DescribeNotificationSubscriptionsRequestRequestTypeDef#
# DescribeNotificationSubscriptionsRequestRequestTypeDef definition
class DescribeNotificationSubscriptionsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Marker: NotRequired[str],
Limit: NotRequired[int],
DescribeResourcePermissionsRequestRequestTypeDef#
# DescribeResourcePermissionsRequestRequestTypeDef definition
class DescribeResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
PrincipalId: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeRootFoldersRequestRequestTypeDef#
# DescribeRootFoldersRequestRequestTypeDef definition
class DescribeRootFoldersRequestRequestTypeDef(TypedDict):
AuthenticationToken: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeUsersRequestRequestTypeDef#
# DescribeUsersRequestRequestTypeDef definition
class DescribeUsersRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
UserIds: NotRequired[str],
Query: NotRequired[str],
Include: NotRequired[UserFilterTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Sort: NotRequired[UserSortTypeType], # (3)
Marker: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
- See UserFilterTypeType
- See OrderTypeType
- See UserSortTypeType
LongRangeTypeTypeDef#
# LongRangeTypeTypeDef definition
class LongRangeTypeTypeDef(TypedDict):
StartValue: NotRequired[int],
EndValue: NotRequired[int],
SearchPrincipalTypeTypeDef#
# SearchPrincipalTypeTypeDef definition
class SearchPrincipalTypeTypeDef(TypedDict):
Id: str,
Roles: NotRequired[Sequence[PrincipalRoleTypeType]], # (1)
GetCurrentUserRequestRequestTypeDef#
# GetCurrentUserRequestRequestTypeDef definition
class GetCurrentUserRequestRequestTypeDef(TypedDict):
AuthenticationToken: str,
GetDocumentPathRequestRequestTypeDef#
# GetDocumentPathRequestRequestTypeDef definition
class GetDocumentPathRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
Marker: NotRequired[str],
GetDocumentRequestRequestTypeDef#
# GetDocumentRequestRequestTypeDef definition
class GetDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetDocumentVersionRequestRequestTypeDef#
# GetDocumentVersionRequestRequestTypeDef definition
class GetDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
Fields: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetFolderPathRequestRequestTypeDef#
# GetFolderPathRequestRequestTypeDef definition
class GetFolderPathRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
Marker: NotRequired[str],
GetFolderRequestRequestTypeDef#
# GetFolderRequestRequestTypeDef definition
class GetFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetResourcesRequestRequestTypeDef#
# GetResourcesRequestRequestTypeDef definition
class GetResourcesRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
UserId: NotRequired[str],
CollectionType: NotRequired[ResourceCollectionTypeType], # (1)
Limit: NotRequired[int],
Marker: NotRequired[str],
UploadMetadataTypeDef#
# UploadMetadataTypeDef definition
class UploadMetadataTypeDef(TypedDict):
UploadUrl: NotRequired[str],
SignedHeaders: NotRequired[Dict[str, str]],
PermissionInfoTypeDef#
# PermissionInfoTypeDef definition
class PermissionInfoTypeDef(TypedDict):
Role: NotRequired[RoleTypeType], # (1)
Type: NotRequired[RolePermissionTypeType], # (2)
- See RoleTypeType
- See RolePermissionTypeType
RemoveAllResourcePermissionsRequestRequestTypeDef#
# RemoveAllResourcePermissionsRequestRequestTypeDef definition
class RemoveAllResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
RemoveResourcePermissionRequestRequestTypeDef#
# RemoveResourcePermissionRequestRequestTypeDef definition
class RemoveResourcePermissionRequestRequestTypeDef(TypedDict):
ResourceId: str,
PrincipalId: str,
AuthenticationToken: NotRequired[str],
PrincipalType: NotRequired[PrincipalTypeType], # (1)
ResourcePathComponentTypeDef#
# ResourcePathComponentTypeDef definition
class ResourcePathComponentTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
RestoreDocumentVersionsRequestRequestTypeDef#
# RestoreDocumentVersionsRequestRequestTypeDef definition
class RestoreDocumentVersionsRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
SearchSortResultTypeDef#
# SearchSortResultTypeDef definition
class SearchSortResultTypeDef(TypedDict):
Field: NotRequired[OrderByFieldTypeType], # (1)
Order: NotRequired[SortOrderType], # (2)
- See OrderByFieldTypeType
- See SortOrderType
UpdateDocumentRequestRequestTypeDef#
# UpdateDocumentRequestRequestTypeDef definition
class UpdateDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
ParentFolderId: NotRequired[str],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
UpdateDocumentVersionRequestRequestTypeDef#
# UpdateDocumentVersionRequestRequestTypeDef definition
class UpdateDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
VersionStatus: NotRequired[DocumentVersionStatusType], # (1)
UpdateFolderRequestRequestTypeDef#
# UpdateFolderRequestRequestTypeDef definition
class UpdateFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
ParentFolderId: NotRequired[str],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResourceMetadataTypeDef#
# ResourceMetadataTypeDef definition
class ResourceMetadataTypeDef(TypedDict):
Type: NotRequired[ResourceTypeType], # (1)
Name: NotRequired[str],
OriginalName: NotRequired[str],
Id: NotRequired[str],
VersionId: NotRequired[str],
Owner: NotRequired[UserMetadataTypeDef], # (2)
ParentId: NotRequired[str],
- See ResourceTypeType
- See UserMetadataTypeDef
AddResourcePermissionsRequestRequestTypeDef#
# AddResourcePermissionsRequestRequestTypeDef definition
class AddResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Principals: Sequence[SharePrincipalTypeDef], # (1)
AuthenticationToken: NotRequired[str],
NotificationOptions: NotRequired[NotificationOptionsTypeDef], # (2)
AddResourcePermissionsResponseTypeDef#
# AddResourcePermissionsResponseTypeDef definition
class AddResourcePermissionsResponseTypeDef(TypedDict):
ShareResults: List[ShareResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateFolderResponseTypeDef#
# CreateFolderResponseTypeDef definition
class CreateFolderResponseTypeDef(TypedDict):
Metadata: FolderMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeRootFoldersResponseTypeDef#
# DescribeRootFoldersResponseTypeDef definition
class DescribeRootFoldersResponseTypeDef(TypedDict):
Folders: List[FolderMetadataTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFolderResponseTypeDef#
# GetFolderResponseTypeDef definition
class GetFolderResponseTypeDef(TypedDict):
Metadata: FolderMetadataTypeDef, # (1)
CustomMetadata: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNotificationSubscriptionResponseTypeDef#
# CreateNotificationSubscriptionResponseTypeDef definition
class CreateNotificationSubscriptionResponseTypeDef(TypedDict):
Subscription: SubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeNotificationSubscriptionsResponseTypeDef#
# DescribeNotificationSubscriptionsResponseTypeDef definition
class DescribeNotificationSubscriptionsResponseTypeDef(TypedDict):
Subscriptions: List[SubscriptionTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
Username: str,
GivenName: str,
Surname: str,
Password: str,
OrganizationId: NotRequired[str],
EmailAddress: NotRequired[str],
TimeZoneId: NotRequired[str],
StorageRule: NotRequired[StorageRuleTypeTypeDef], # (1)
AuthenticationToken: NotRequired[str],
UpdateUserRequestRequestTypeDef#
# UpdateUserRequestRequestTypeDef definition
class UpdateUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
GivenName: NotRequired[str],
Surname: NotRequired[str],
Type: NotRequired[UserTypeType], # (1)
StorageRule: NotRequired[StorageRuleTypeTypeDef], # (2)
TimeZoneId: NotRequired[str],
Locale: NotRequired[LocaleTypeType], # (3)
GrantPoweruserPrivileges: NotRequired[BooleanEnumTypeType], # (4)
- See UserTypeType
- See StorageRuleTypeTypeDef
- See LocaleTypeType
- See BooleanEnumTypeType
UserStorageMetadataTypeDef#
# UserStorageMetadataTypeDef definition
class UserStorageMetadataTypeDef(TypedDict):
StorageUtilizedInBytes: NotRequired[int],
StorageRule: NotRequired[StorageRuleTypeTypeDef], # (1)
DateRangeTypeTypeDef#
# DateRangeTypeTypeDef definition
class DateRangeTypeTypeDef(TypedDict):
StartValue: NotRequired[Union[datetime, str]],
EndValue: NotRequired[Union[datetime, str]],
DescribeActivitiesRequestRequestTypeDef#
# DescribeActivitiesRequestRequestTypeDef definition
class DescribeActivitiesRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
StartTime: NotRequired[Union[datetime, str]],
EndTime: NotRequired[Union[datetime, str]],
OrganizationId: NotRequired[str],
ActivityTypes: NotRequired[str],
ResourceId: NotRequired[str],
UserId: NotRequired[str],
IncludeIndirectActivities: NotRequired[bool],
Limit: NotRequired[int],
Marker: NotRequired[str],
InitiateDocumentVersionUploadRequestRequestTypeDef#
# InitiateDocumentVersionUploadRequestRequestTypeDef definition
class InitiateDocumentVersionUploadRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
Id: NotRequired[str],
Name: NotRequired[str],
ContentCreatedTimestamp: NotRequired[Union[datetime, str]],
ContentModifiedTimestamp: NotRequired[Union[datetime, str]],
ContentType: NotRequired[str],
DocumentSizeInBytes: NotRequired[int],
ParentFolderId: NotRequired[str],
DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef#
# DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef definition
class DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
StartTime: NotRequired[Union[datetime, str]],
EndTime: NotRequired[Union[datetime, str]],
OrganizationId: NotRequired[str],
ActivityTypes: NotRequired[str],
ResourceId: NotRequired[str],
UserId: NotRequired[str],
IncludeIndirectActivities: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeCommentsRequestDescribeCommentsPaginateTypeDef#
# DescribeCommentsRequestDescribeCommentsPaginateTypeDef definition
class DescribeCommentsRequestDescribeCommentsPaginateTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef#
# DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef definition
class DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Include: NotRequired[str],
Fields: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef#
# DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef definition
class DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Sort: NotRequired[ResourceSortTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Type: NotRequired[FolderContentTypeType], # (3)
Include: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ResourceSortTypeType
- See OrderTypeType
- See FolderContentTypeType
- See PaginatorConfigTypeDef
DescribeGroupsRequestDescribeGroupsPaginateTypeDef#
# DescribeGroupsRequestDescribeGroupsPaginateTypeDef definition
class DescribeGroupsRequestDescribeGroupsPaginateTypeDef(TypedDict):
SearchQuery: str,
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef#
# DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef definition
class DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef(TypedDict):
OrganizationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef#
# DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef definition
class DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
PrincipalId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef#
# DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef definition
class DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef(TypedDict):
AuthenticationToken: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeUsersRequestDescribeUsersPaginateTypeDef#
# DescribeUsersRequestDescribeUsersPaginateTypeDef definition
class DescribeUsersRequestDescribeUsersPaginateTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
UserIds: NotRequired[str],
Query: NotRequired[str],
Include: NotRequired[UserFilterTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Sort: NotRequired[UserSortTypeType], # (3)
Fields: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See UserFilterTypeType
- See OrderTypeType
- See UserSortTypeType
- See PaginatorConfigTypeDef
DescribeDocumentVersionsResponseTypeDef#
# DescribeDocumentVersionsResponseTypeDef definition
class DescribeDocumentVersionsResponseTypeDef(TypedDict):
DocumentVersions: List[DocumentVersionMetadataTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentMetadataTypeDef#
# DocumentMetadataTypeDef definition
class DocumentMetadataTypeDef(TypedDict):
Id: NotRequired[str],
CreatorId: NotRequired[str],
ParentFolderId: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
LatestVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef], # (1)
ResourceState: NotRequired[ResourceStateTypeType], # (2)
Labels: NotRequired[List[str]],
GetDocumentVersionResponseTypeDef#
# GetDocumentVersionResponseTypeDef definition
class GetDocumentVersionResponseTypeDef(TypedDict):
Metadata: DocumentVersionMetadataTypeDef, # (1)
CustomMetadata: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeGroupsResponseTypeDef#
# DescribeGroupsResponseTypeDef definition
class DescribeGroupsResponseTypeDef(TypedDict):
Groups: List[GroupMetadataTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ParticipantsTypeDef#
# ParticipantsTypeDef definition
class ParticipantsTypeDef(TypedDict):
Users: NotRequired[List[UserMetadataTypeDef]], # (1)
Groups: NotRequired[List[GroupMetadataTypeDef]], # (2)
PrincipalTypeDef#
# PrincipalTypeDef definition
class PrincipalTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[PrincipalTypeType], # (1)
Roles: NotRequired[List[PermissionInfoTypeDef]], # (2)
ResourcePathTypeDef#
# ResourcePathTypeDef definition
class ResourcePathTypeDef(TypedDict):
Components: NotRequired[List[ResourcePathComponentTypeDef]], # (1)
UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
Id: NotRequired[str],
Username: NotRequired[str],
EmailAddress: NotRequired[str],
GivenName: NotRequired[str],
Surname: NotRequired[str],
OrganizationId: NotRequired[str],
RootFolderId: NotRequired[str],
RecycleBinFolderId: NotRequired[str],
Status: NotRequired[UserStatusTypeType], # (1)
Type: NotRequired[UserTypeType], # (2)
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
TimeZoneId: NotRequired[str],
Locale: NotRequired[LocaleTypeType], # (3)
Storage: NotRequired[UserStorageMetadataTypeDef], # (4)
- See UserStatusTypeType
- See UserTypeType
- See LocaleTypeType
- See UserStorageMetadataTypeDef
FiltersTypeDef#
# FiltersTypeDef definition
class FiltersTypeDef(TypedDict):
TextLocales: NotRequired[Sequence[LanguageCodeTypeType]], # (1)
ContentCategories: NotRequired[Sequence[ContentCategoryTypeType]], # (2)
ResourceTypes: NotRequired[Sequence[SearchResourceTypeType]], # (3)
Labels: NotRequired[Sequence[str]],
Principals: NotRequired[Sequence[SearchPrincipalTypeTypeDef]], # (4)
AncestorIds: NotRequired[Sequence[str]],
SearchCollectionTypes: NotRequired[Sequence[SearchCollectionTypeType]], # (5)
SizeRange: NotRequired[LongRangeTypeTypeDef], # (6)
CreatedRange: NotRequired[DateRangeTypeTypeDef], # (7)
ModifiedRange: NotRequired[DateRangeTypeTypeDef], # (7)
- See LanguageCodeTypeType
- See ContentCategoryTypeType
- See SearchResourceTypeType
- See SearchPrincipalTypeTypeDef
- See SearchCollectionTypeType
- See LongRangeTypeTypeDef
- See DateRangeTypeTypeDef
- See DateRangeTypeTypeDef
DescribeFolderContentsResponseTypeDef#
# DescribeFolderContentsResponseTypeDef definition
class DescribeFolderContentsResponseTypeDef(TypedDict):
Folders: List[FolderMetadataTypeDef], # (1)
Documents: List[DocumentMetadataTypeDef], # (2)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetDocumentResponseTypeDef#
# GetDocumentResponseTypeDef definition
class GetDocumentResponseTypeDef(TypedDict):
Metadata: DocumentMetadataTypeDef, # (1)
CustomMetadata: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetResourcesResponseTypeDef#
# GetResourcesResponseTypeDef definition
class GetResourcesResponseTypeDef(TypedDict):
Folders: List[FolderMetadataTypeDef], # (1)
Documents: List[DocumentMetadataTypeDef], # (2)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
InitiateDocumentVersionUploadResponseTypeDef#
# InitiateDocumentVersionUploadResponseTypeDef definition
class InitiateDocumentVersionUploadResponseTypeDef(TypedDict):
Metadata: DocumentMetadataTypeDef, # (1)
UploadMetadata: UploadMetadataTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeResourcePermissionsResponseTypeDef#
# DescribeResourcePermissionsResponseTypeDef definition
class DescribeResourcePermissionsResponseTypeDef(TypedDict):
Principals: List[PrincipalTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDocumentPathResponseTypeDef#
# GetDocumentPathResponseTypeDef definition
class GetDocumentPathResponseTypeDef(TypedDict):
Path: ResourcePathTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFolderPathResponseTypeDef#
# GetFolderPathResponseTypeDef definition
class GetFolderPathResponseTypeDef(TypedDict):
Path: ResourcePathTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ActivateUserResponseTypeDef#
# ActivateUserResponseTypeDef definition
class ActivateUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
CommentMetadataTypeDef#
# CommentMetadataTypeDef definition
class CommentMetadataTypeDef(TypedDict):
CommentId: NotRequired[str],
Contributor: NotRequired[UserTypeDef], # (1)
CreatedTimestamp: NotRequired[datetime],
CommentStatus: NotRequired[CommentStatusTypeType], # (2)
RecipientId: NotRequired[str],
ContributorId: NotRequired[str],
- See UserTypeDef
- See CommentStatusTypeType
CommentTypeDef#
# CommentTypeDef definition
class CommentTypeDef(TypedDict):
CommentId: str,
ParentId: NotRequired[str],
ThreadId: NotRequired[str],
Text: NotRequired[str],
Contributor: NotRequired[UserTypeDef], # (1)
CreatedTimestamp: NotRequired[datetime],
Status: NotRequired[CommentStatusTypeType], # (2)
Visibility: NotRequired[CommentVisibilityTypeType], # (3)
RecipientId: NotRequired[str],
CreateUserResponseTypeDef#
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
DescribeUsersResponseTypeDef#
# DescribeUsersResponseTypeDef definition
class DescribeUsersResponseTypeDef(TypedDict):
Users: List[UserTypeDef], # (1)
TotalNumberOfUsers: int,
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
GetCurrentUserResponseTypeDef#
# GetCurrentUserResponseTypeDef definition
class GetCurrentUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
SearchResourcesRequestRequestTypeDef#
# SearchResourcesRequestRequestTypeDef definition
class SearchResourcesRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
QueryText: NotRequired[str],
QueryScopes: NotRequired[Sequence[SearchQueryScopeTypeType]], # (1)
OrganizationId: NotRequired[str],
AdditionalResponseFields: NotRequired[Sequence[AdditionalResponseFieldTypeType]], # (2)
Filters: NotRequired[FiltersTypeDef], # (3)
OrderBy: NotRequired[Sequence[SearchSortResultTypeDef]], # (4)
Limit: NotRequired[int],
Marker: NotRequired[str],
- See SearchQueryScopeTypeType
- See AdditionalResponseFieldTypeType
- See FiltersTypeDef
- See SearchSortResultTypeDef
SearchResourcesRequestSearchResourcesPaginateTypeDef#
# SearchResourcesRequestSearchResourcesPaginateTypeDef definition
class SearchResourcesRequestSearchResourcesPaginateTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
QueryText: NotRequired[str],
QueryScopes: NotRequired[Sequence[SearchQueryScopeTypeType]], # (1)
OrganizationId: NotRequired[str],
AdditionalResponseFields: NotRequired[Sequence[AdditionalResponseFieldTypeType]], # (2)
Filters: NotRequired[FiltersTypeDef], # (3)
OrderBy: NotRequired[Sequence[SearchSortResultTypeDef]], # (4)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (5)
- See SearchQueryScopeTypeType
- See AdditionalResponseFieldTypeType
- See FiltersTypeDef
- See SearchSortResultTypeDef
- See PaginatorConfigTypeDef
ActivityTypeDef#
# ActivityTypeDef definition
class ActivityTypeDef(TypedDict):
Type: NotRequired[ActivityTypeType], # (1)
TimeStamp: NotRequired[datetime],
IsIndirectActivity: NotRequired[bool],
OrganizationId: NotRequired[str],
Initiator: NotRequired[UserMetadataTypeDef], # (2)
Participants: NotRequired[ParticipantsTypeDef], # (3)
ResourceMetadata: NotRequired[ResourceMetadataTypeDef], # (4)
OriginalParent: NotRequired[ResourceMetadataTypeDef], # (4)
CommentMetadata: NotRequired[CommentMetadataTypeDef], # (6)
- See ActivityTypeType
- See UserMetadataTypeDef
- See ParticipantsTypeDef
- See ResourceMetadataTypeDef
- See ResourceMetadataTypeDef
- See CommentMetadataTypeDef
ResponseItemTypeDef#
# ResponseItemTypeDef definition
class ResponseItemTypeDef(TypedDict):
ResourceType: NotRequired[ResponseItemTypeType], # (1)
WebUrl: NotRequired[str],
DocumentMetadata: NotRequired[DocumentMetadataTypeDef], # (2)
FolderMetadata: NotRequired[FolderMetadataTypeDef], # (3)
CommentMetadata: NotRequired[CommentMetadataTypeDef], # (4)
DocumentVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef], # (5)
- See ResponseItemTypeType
- See DocumentMetadataTypeDef
- See FolderMetadataTypeDef
- See CommentMetadataTypeDef
- See DocumentVersionMetadataTypeDef
CreateCommentResponseTypeDef#
# CreateCommentResponseTypeDef definition
class CreateCommentResponseTypeDef(TypedDict):
Comment: CommentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCommentsResponseTypeDef#
# DescribeCommentsResponseTypeDef definition
class DescribeCommentsResponseTypeDef(TypedDict):
Comments: List[CommentTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeActivitiesResponseTypeDef#
# DescribeActivitiesResponseTypeDef definition
class DescribeActivitiesResponseTypeDef(TypedDict):
UserActivities: List[ActivityTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchResourcesResponseTypeDef#
# SearchResourcesResponseTypeDef definition
class SearchResourcesResponseTypeDef(TypedDict):
Items: List[ResponseItemTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)