Type definitions#
Index > WorkSpaces > Type definitions
Auto-generated documentation for WorkSpaces type annotations stubs module mypy-boto3-workspaces.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
AccountModificationTypeDef#
# AccountModificationTypeDef definition
class AccountModificationTypeDef(TypedDict):
ModificationState: NotRequired[DedicatedTenancyModificationStateEnumType], # (1)
DedicatedTenancySupport: NotRequired[DedicatedTenancySupportResultEnumType], # (2)
DedicatedTenancyManagementCidrRange: NotRequired[str],
StartTime: NotRequired[datetime],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
AssociationStateReasonTypeDef#
# AssociationStateReasonTypeDef definition
class AssociationStateReasonTypeDef(TypedDict):
ErrorCode: NotRequired[AssociationErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
AssociateConnectionAliasRequestRequestTypeDef#
# AssociateConnectionAliasRequestRequestTypeDef definition
class AssociateConnectionAliasRequestRequestTypeDef(TypedDict):
AliasId: str,
ResourceId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AssociateIpGroupsRequestRequestTypeDef#
# AssociateIpGroupsRequestRequestTypeDef definition
class AssociateIpGroupsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
GroupIds: Sequence[str],
AssociateWorkspaceApplicationRequestRequestTypeDef#
# AssociateWorkspaceApplicationRequestRequestTypeDef definition
class AssociateWorkspaceApplicationRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
ApplicationId: str,
IpRuleItemTypeDef#
# IpRuleItemTypeDef definition
class IpRuleItemTypeDef(TypedDict):
ipRule: NotRequired[str],
ruleDesc: NotRequired[str],
CertificateBasedAuthPropertiesTypeDef#
# CertificateBasedAuthPropertiesTypeDef definition
class CertificateBasedAuthPropertiesTypeDef(TypedDict):
Status: NotRequired[CertificateBasedAuthStatusEnumType], # (1)
CertificateAuthorityArn: NotRequired[str],
ClientPropertiesTypeDef#
# ClientPropertiesTypeDef definition
class ClientPropertiesTypeDef(TypedDict):
ReconnectEnabled: NotRequired[ReconnectEnumType], # (1)
LogUploadEnabled: NotRequired[LogUploadEnumType], # (2)
- See ReconnectEnumType
- See LogUploadEnumType
ComputeTypeTypeDef#
# ComputeTypeTypeDef definition
class ComputeTypeTypeDef(TypedDict):
Name: NotRequired[ComputeType], # (1)
- See ComputeType
ConnectClientAddInTypeDef#
# ConnectClientAddInTypeDef definition
class ConnectClientAddInTypeDef(TypedDict):
AddInId: NotRequired[str],
ResourceId: NotRequired[str],
Name: NotRequired[str],
URL: NotRequired[str],
ConnectionAliasAssociationTypeDef#
# ConnectionAliasAssociationTypeDef definition
class ConnectionAliasAssociationTypeDef(TypedDict):
AssociationStatus: NotRequired[AssociationStatusType], # (1)
AssociatedAccountId: NotRequired[str],
ResourceId: NotRequired[str],
ConnectionIdentifier: NotRequired[str],
ConnectionAliasPermissionTypeDef#
# ConnectionAliasPermissionTypeDef definition
class ConnectionAliasPermissionTypeDef(TypedDict):
SharedAccountId: str,
AllowAssociation: bool,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],
CreateConnectClientAddInRequestRequestTypeDef#
# CreateConnectClientAddInRequestRequestTypeDef definition
class CreateConnectClientAddInRequestRequestTypeDef(TypedDict):
ResourceId: str,
Name: str,
URL: str,
PendingCreateStandbyWorkspacesRequestTypeDef#
# PendingCreateStandbyWorkspacesRequestTypeDef definition
class PendingCreateStandbyWorkspacesRequestTypeDef(TypedDict):
UserName: NotRequired[str],
DirectoryId: NotRequired[str],
State: NotRequired[WorkspaceStateType], # (1)
WorkspaceId: NotRequired[str],
RootStorageTypeDef#
# RootStorageTypeDef definition
class RootStorageTypeDef(TypedDict):
Capacity: NotRequired[str],
UserStorageTypeDef#
# UserStorageTypeDef definition
class UserStorageTypeDef(TypedDict):
Capacity: NotRequired[str],
OperatingSystemTypeDef#
# OperatingSystemTypeDef definition
class OperatingSystemTypeDef(TypedDict):
Type: NotRequired[OperatingSystemTypeType], # (1)
DataReplicationSettingsTypeDef#
# DataReplicationSettingsTypeDef definition
class DataReplicationSettingsTypeDef(TypedDict):
DataReplication: NotRequired[DataReplicationType], # (1)
RecoverySnapshotTime: NotRequired[datetime],
DefaultClientBrandingAttributesTypeDef#
# DefaultClientBrandingAttributesTypeDef definition
class DefaultClientBrandingAttributesTypeDef(TypedDict):
LogoUrl: NotRequired[str],
SupportEmail: NotRequired[str],
SupportLink: NotRequired[str],
ForgotPasswordLink: NotRequired[str],
LoginMessage: NotRequired[Dict[str, str]],
DefaultWorkspaceCreationPropertiesTypeDef#
# DefaultWorkspaceCreationPropertiesTypeDef definition
class DefaultWorkspaceCreationPropertiesTypeDef(TypedDict):
EnableWorkDocs: NotRequired[bool],
EnableInternetAccess: NotRequired[bool],
DefaultOu: NotRequired[str],
CustomSecurityGroupId: NotRequired[str],
UserEnabledAsLocalAdministrator: NotRequired[bool],
EnableMaintenanceMode: NotRequired[bool],
DeleteClientBrandingRequestRequestTypeDef#
# DeleteClientBrandingRequestRequestTypeDef definition
class DeleteClientBrandingRequestRequestTypeDef(TypedDict):
ResourceId: str,
Platforms: Sequence[ClientDeviceTypeType], # (1)
DeleteConnectClientAddInRequestRequestTypeDef#
# DeleteConnectClientAddInRequestRequestTypeDef definition
class DeleteConnectClientAddInRequestRequestTypeDef(TypedDict):
AddInId: str,
ResourceId: str,
DeleteConnectionAliasRequestRequestTypeDef#
# DeleteConnectionAliasRequestRequestTypeDef definition
class DeleteConnectionAliasRequestRequestTypeDef(TypedDict):
AliasId: str,
DeleteIpGroupRequestRequestTypeDef#
# DeleteIpGroupRequestRequestTypeDef definition
class DeleteIpGroupRequestRequestTypeDef(TypedDict):
GroupId: str,
DeleteTagsRequestRequestTypeDef#
# DeleteTagsRequestRequestTypeDef definition
class DeleteTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
TagKeys: Sequence[str],
DeleteWorkspaceBundleRequestRequestTypeDef#
# DeleteWorkspaceBundleRequestRequestTypeDef definition
class DeleteWorkspaceBundleRequestRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
DeleteWorkspaceImageRequestRequestTypeDef#
# DeleteWorkspaceImageRequestRequestTypeDef definition
class DeleteWorkspaceImageRequestRequestTypeDef(TypedDict):
ImageId: str,
DeployWorkspaceApplicationsRequestRequestTypeDef#
# DeployWorkspaceApplicationsRequestRequestTypeDef definition
class DeployWorkspaceApplicationsRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
Force: NotRequired[bool],
DeregisterWorkspaceDirectoryRequestRequestTypeDef#
# DeregisterWorkspaceDirectoryRequestRequestTypeDef definition
class DeregisterWorkspaceDirectoryRequestRequestTypeDef(TypedDict):
DirectoryId: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAccountModificationsRequestRequestTypeDef#
# DescribeAccountModificationsRequestRequestTypeDef definition
class DescribeAccountModificationsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
DescribeApplicationAssociationsRequestRequestTypeDef#
# DescribeApplicationAssociationsRequestRequestTypeDef definition
class DescribeApplicationAssociationsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
AssociatedResourceTypes: Sequence[ApplicationAssociatedResourceTypeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
DescribeApplicationsRequestRequestTypeDef#
# DescribeApplicationsRequestRequestTypeDef definition
class DescribeApplicationsRequestRequestTypeDef(TypedDict):
ApplicationIds: NotRequired[Sequence[str]],
ComputeTypeNames: NotRequired[Sequence[ComputeType]], # (1)
LicenseType: NotRequired[WorkSpaceApplicationLicenseTypeType], # (2)
OperatingSystemNames: NotRequired[Sequence[OperatingSystemNameType]], # (3)
Owner: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WorkSpaceApplicationTypeDef#
# WorkSpaceApplicationTypeDef definition
class WorkSpaceApplicationTypeDef(TypedDict):
ApplicationId: NotRequired[str],
Created: NotRequired[datetime],
Description: NotRequired[str],
LicenseType: NotRequired[WorkSpaceApplicationLicenseTypeType], # (1)
Name: NotRequired[str],
Owner: NotRequired[str],
State: NotRequired[WorkSpaceApplicationStateType], # (2)
SupportedComputeTypeNames: NotRequired[List[ComputeType]], # (3)
SupportedOperatingSystemNames: NotRequired[List[OperatingSystemNameType]], # (4)
- See WorkSpaceApplicationLicenseTypeType
- See WorkSpaceApplicationStateType
- See ComputeType
- See OperatingSystemNameType
DescribeBundleAssociationsRequestRequestTypeDef#
# DescribeBundleAssociationsRequestRequestTypeDef definition
class DescribeBundleAssociationsRequestRequestTypeDef(TypedDict):
BundleId: str,
AssociatedResourceTypes: Sequence[BundleAssociatedResourceTypeType], # (1)
DescribeClientBrandingRequestRequestTypeDef#
# DescribeClientBrandingRequestRequestTypeDef definition
class DescribeClientBrandingRequestRequestTypeDef(TypedDict):
ResourceId: str,
IosClientBrandingAttributesTypeDef#
# IosClientBrandingAttributesTypeDef definition
class IosClientBrandingAttributesTypeDef(TypedDict):
LogoUrl: NotRequired[str],
Logo2xUrl: NotRequired[str],
Logo3xUrl: NotRequired[str],
SupportEmail: NotRequired[str],
SupportLink: NotRequired[str],
ForgotPasswordLink: NotRequired[str],
LoginMessage: NotRequired[Dict[str, str]],
DescribeClientPropertiesRequestRequestTypeDef#
# DescribeClientPropertiesRequestRequestTypeDef definition
class DescribeClientPropertiesRequestRequestTypeDef(TypedDict):
ResourceIds: Sequence[str],
DescribeConnectClientAddInsRequestRequestTypeDef#
# DescribeConnectClientAddInsRequestRequestTypeDef definition
class DescribeConnectClientAddInsRequestRequestTypeDef(TypedDict):
ResourceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeConnectionAliasPermissionsRequestRequestTypeDef#
# DescribeConnectionAliasPermissionsRequestRequestTypeDef definition
class DescribeConnectionAliasPermissionsRequestRequestTypeDef(TypedDict):
AliasId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeConnectionAliasesRequestRequestTypeDef#
# DescribeConnectionAliasesRequestRequestTypeDef definition
class DescribeConnectionAliasesRequestRequestTypeDef(TypedDict):
AliasIds: NotRequired[Sequence[str]],
ResourceId: NotRequired[str],
Limit: NotRequired[int],
NextToken: NotRequired[str],
DescribeImageAssociationsRequestRequestTypeDef#
# DescribeImageAssociationsRequestRequestTypeDef definition
class DescribeImageAssociationsRequestRequestTypeDef(TypedDict):
ImageId: str,
AssociatedResourceTypes: Sequence[ImageAssociatedResourceTypeType], # (1)
DescribeIpGroupsRequestRequestTypeDef#
# DescribeIpGroupsRequestRequestTypeDef definition
class DescribeIpGroupsRequestRequestTypeDef(TypedDict):
GroupIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeTagsRequestRequestTypeDef#
# DescribeTagsRequestRequestTypeDef definition
class DescribeTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
DescribeWorkspaceAssociationsRequestRequestTypeDef#
# DescribeWorkspaceAssociationsRequestRequestTypeDef definition
class DescribeWorkspaceAssociationsRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
AssociatedResourceTypes: Sequence[WorkSpaceAssociatedResourceTypeType], # (1)
DescribeWorkspaceBundlesRequestRequestTypeDef#
# DescribeWorkspaceBundlesRequestRequestTypeDef definition
class DescribeWorkspaceBundlesRequestRequestTypeDef(TypedDict):
BundleIds: NotRequired[Sequence[str]],
Owner: NotRequired[str],
NextToken: NotRequired[str],
DescribeWorkspaceDirectoriesRequestRequestTypeDef#
# DescribeWorkspaceDirectoriesRequestRequestTypeDef definition
class DescribeWorkspaceDirectoriesRequestRequestTypeDef(TypedDict):
DirectoryIds: NotRequired[Sequence[str]],
Limit: NotRequired[int],
NextToken: NotRequired[str],
DescribeWorkspaceImagePermissionsRequestRequestTypeDef#
# DescribeWorkspaceImagePermissionsRequestRequestTypeDef definition
class DescribeWorkspaceImagePermissionsRequestRequestTypeDef(TypedDict):
ImageId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ImagePermissionTypeDef#
# ImagePermissionTypeDef definition
class ImagePermissionTypeDef(TypedDict):
SharedAccountId: NotRequired[str],
DescribeWorkspaceImagesRequestRequestTypeDef#
# DescribeWorkspaceImagesRequestRequestTypeDef definition
class DescribeWorkspaceImagesRequestRequestTypeDef(TypedDict):
ImageIds: NotRequired[Sequence[str]],
ImageType: NotRequired[ImageTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See ImageTypeType
DescribeWorkspaceSnapshotsRequestRequestTypeDef#
# DescribeWorkspaceSnapshotsRequestRequestTypeDef definition
class DescribeWorkspaceSnapshotsRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
SnapshotTypeDef#
# SnapshotTypeDef definition
class SnapshotTypeDef(TypedDict):
SnapshotTime: NotRequired[datetime],
DescribeWorkspacesConnectionStatusRequestRequestTypeDef#
# DescribeWorkspacesConnectionStatusRequestRequestTypeDef definition
class DescribeWorkspacesConnectionStatusRequestRequestTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
WorkspaceConnectionStatusTypeDef#
# WorkspaceConnectionStatusTypeDef definition
class WorkspaceConnectionStatusTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
ConnectionState: NotRequired[ConnectionStateType], # (1)
ConnectionStateCheckTimestamp: NotRequired[datetime],
LastKnownUserConnectionTimestamp: NotRequired[datetime],