Typed dictionaries
Index > WorkSpaces > Typed dictionaries
Auto-generated documentation for WorkSpaces type annotations stubs module mypy-boto3-workspaces.
AccountModificationTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import AccountModificationTypeDef
def get_value() -> AccountModificationTypeDef:
return {
"ModificationState": ...,
}
Definition
class AccountModificationTypeDef(TypedDict):
ModificationState: NotRequired[DedicatedTenancyModificationStateEnumType], # (1)
DedicatedTenancySupport: NotRequired[DedicatedTenancySupportResultEnumType], # (2)
DedicatedTenancyManagementCidrRange: NotRequired[str],
StartTime: NotRequired[datetime],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
AssociateConnectionAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import AssociateConnectionAliasRequestRequestTypeDef
def get_value() -> AssociateConnectionAliasRequestRequestTypeDef:
return {
"AliasId": ...,
"ResourceId": ...,
}
Definition
class AssociateConnectionAliasRequestRequestTypeDef(TypedDict):
AliasId: str,
ResourceId: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_workspaces.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,
AssociateIpGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import AssociateIpGroupsRequestRequestTypeDef
def get_value() -> AssociateIpGroupsRequestRequestTypeDef:
return {
"DirectoryId": ...,
"GroupIds": ...,
}
Definition
class AssociateIpGroupsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
GroupIds: Sequence[str],
IpRuleItemTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import IpRuleItemTypeDef
def get_value() -> IpRuleItemTypeDef:
return {
"ipRule": ...,
}
CertificateBasedAuthPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CertificateBasedAuthPropertiesTypeDef
def get_value() -> CertificateBasedAuthPropertiesTypeDef:
return {
"Status": ...,
}
Definition
class CertificateBasedAuthPropertiesTypeDef(TypedDict):
Status: NotRequired[CertificateBasedAuthStatusEnumType], # (1)
CertificateAuthorityArn: NotRequired[str],
ClientPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ClientPropertiesTypeDef
def get_value() -> ClientPropertiesTypeDef:
return {
"ReconnectEnabled": ...,
}
Definition
class ClientPropertiesTypeDef(TypedDict):
ReconnectEnabled: NotRequired[ReconnectEnumType], # (1)
LogUploadEnabled: NotRequired[LogUploadEnumType], # (2)
- See ReconnectEnumType
- See LogUploadEnumType
ComputeTypeTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ComputeTypeTypeDef
def get_value() -> ComputeTypeTypeDef:
return {
"Name": ...,
}
- See ComputeType
ConnectClientAddInTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ConnectClientAddInTypeDef
def get_value() -> ConnectClientAddInTypeDef:
return {
"AddInId": ...,
}
Definition
class ConnectClientAddInTypeDef(TypedDict):
AddInId: NotRequired[str],
ResourceId: NotRequired[str],
Name: NotRequired[str],
URL: NotRequired[str],
ConnectionAliasAssociationTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ConnectionAliasAssociationTypeDef
def get_value() -> ConnectionAliasAssociationTypeDef:
return {
"AssociationStatus": ...,
}
Definition
class ConnectionAliasAssociationTypeDef(TypedDict):
AssociationStatus: NotRequired[AssociationStatusType], # (1)
AssociatedAccountId: NotRequired[str],
ResourceId: NotRequired[str],
ConnectionIdentifier: NotRequired[str],
ConnectionAliasPermissionTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ConnectionAliasPermissionTypeDef
def get_value() -> ConnectionAliasPermissionTypeDef:
return {
"SharedAccountId": ...,
"AllowAssociation": ...,
}
Definition
class ConnectionAliasPermissionTypeDef(TypedDict):
SharedAccountId: str,
AllowAssociation: bool,
TagTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
CreateConnectClientAddInRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateConnectClientAddInRequestRequestTypeDef
def get_value() -> CreateConnectClientAddInRequestRequestTypeDef:
return {
"ResourceId": ...,
"Name": ...,
"URL": ...,
}
Definition
class CreateConnectClientAddInRequestRequestTypeDef(TypedDict):
ResourceId: str,
Name: str,
URL: str,
PendingCreateStandbyWorkspacesRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import PendingCreateStandbyWorkspacesRequestTypeDef
def get_value() -> PendingCreateStandbyWorkspacesRequestTypeDef:
return {
"UserName": ...,
}
Definition
class PendingCreateStandbyWorkspacesRequestTypeDef(TypedDict):
UserName: NotRequired[str],
DirectoryId: NotRequired[str],
State: NotRequired[WorkspaceStateType], # (1)
WorkspaceId: NotRequired[str],
RootStorageTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RootStorageTypeDef
def get_value() -> RootStorageTypeDef:
return {
"Capacity": ...,
}
UserStorageTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UserStorageTypeDef
def get_value() -> UserStorageTypeDef:
return {
"Capacity": ...,
}
OperatingSystemTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import OperatingSystemTypeDef
def get_value() -> OperatingSystemTypeDef:
return {
"Type": ...,
}
Definition
class OperatingSystemTypeDef(TypedDict):
Type: NotRequired[OperatingSystemTypeType], # (1)
DefaultClientBrandingAttributesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DefaultClientBrandingAttributesTypeDef
def get_value() -> DefaultClientBrandingAttributesTypeDef:
return {
"LogoUrl": ...,
}
Definition
class DefaultClientBrandingAttributesTypeDef(TypedDict):
LogoUrl: NotRequired[str],
SupportEmail: NotRequired[str],
SupportLink: NotRequired[str],
ForgotPasswordLink: NotRequired[str],
LoginMessage: NotRequired[Dict[str, str]],
DefaultImportClientBrandingAttributesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DefaultImportClientBrandingAttributesTypeDef
def get_value() -> DefaultImportClientBrandingAttributesTypeDef:
return {
"Logo": ...,
}
Definition
class DefaultImportClientBrandingAttributesTypeDef(TypedDict):
Logo: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
SupportEmail: NotRequired[str],
SupportLink: NotRequired[str],
ForgotPasswordLink: NotRequired[str],
LoginMessage: NotRequired[Mapping[str, str]],
DefaultWorkspaceCreationPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DefaultWorkspaceCreationPropertiesTypeDef
def get_value() -> DefaultWorkspaceCreationPropertiesTypeDef:
return {
"EnableWorkDocs": ...,
}
Definition
class DefaultWorkspaceCreationPropertiesTypeDef(TypedDict):
EnableWorkDocs: NotRequired[bool],
EnableInternetAccess: NotRequired[bool],
DefaultOu: NotRequired[str],
CustomSecurityGroupId: NotRequired[str],
UserEnabledAsLocalAdministrator: NotRequired[bool],
EnableMaintenanceMode: NotRequired[bool],
DeleteClientBrandingRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteClientBrandingRequestRequestTypeDef
def get_value() -> DeleteClientBrandingRequestRequestTypeDef:
return {
"ResourceId": ...,
"Platforms": ...,
}
Definition
class DeleteClientBrandingRequestRequestTypeDef(TypedDict):
ResourceId: str,
Platforms: Sequence[ClientDeviceTypeType], # (1)
DeleteConnectClientAddInRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteConnectClientAddInRequestRequestTypeDef
def get_value() -> DeleteConnectClientAddInRequestRequestTypeDef:
return {
"AddInId": ...,
"ResourceId": ...,
}
Definition
class DeleteConnectClientAddInRequestRequestTypeDef(TypedDict):
AddInId: str,
ResourceId: str,
DeleteConnectionAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteConnectionAliasRequestRequestTypeDef
def get_value() -> DeleteConnectionAliasRequestRequestTypeDef:
return {
"AliasId": ...,
}
DeleteIpGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteIpGroupRequestRequestTypeDef
def get_value() -> DeleteIpGroupRequestRequestTypeDef:
return {
"GroupId": ...,
}
DeleteTagsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteTagsRequestRequestTypeDef
def get_value() -> DeleteTagsRequestRequestTypeDef:
return {
"ResourceId": ...,
"TagKeys": ...,
}
Definition
class DeleteTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
TagKeys: Sequence[str],
DeleteWorkspaceBundleRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteWorkspaceBundleRequestRequestTypeDef
def get_value() -> DeleteWorkspaceBundleRequestRequestTypeDef:
return {
"BundleId": ...,
}
DeleteWorkspaceImageRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeleteWorkspaceImageRequestRequestTypeDef
def get_value() -> DeleteWorkspaceImageRequestRequestTypeDef:
return {
"ImageId": ...,
}
DeregisterWorkspaceDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DeregisterWorkspaceDirectoryRequestRequestTypeDef
def get_value() -> DeregisterWorkspaceDirectoryRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAccountModificationsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsRequestRequestTypeDef
def get_value() -> DescribeAccountModificationsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class DescribeAccountModificationsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
DescribeClientBrandingRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeClientBrandingRequestRequestTypeDef
def get_value() -> DescribeClientBrandingRequestRequestTypeDef:
return {
"ResourceId": ...,
}
IosClientBrandingAttributesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import IosClientBrandingAttributesTypeDef
def get_value() -> IosClientBrandingAttributesTypeDef:
return {
"LogoUrl": ...,
}
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
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeClientPropertiesRequestRequestTypeDef
def get_value() -> DescribeClientPropertiesRequestRequestTypeDef:
return {
"ResourceIds": ...,
}
Definition
class DescribeClientPropertiesRequestRequestTypeDef(TypedDict):
ResourceIds: Sequence[str],
DescribeConnectClientAddInsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectClientAddInsRequestRequestTypeDef
def get_value() -> DescribeConnectClientAddInsRequestRequestTypeDef:
return {
"ResourceId": ...,
}
Definition
class DescribeConnectClientAddInsRequestRequestTypeDef(TypedDict):
ResourceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeConnectionAliasPermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasPermissionsRequestRequestTypeDef
def get_value() -> DescribeConnectionAliasPermissionsRequestRequestTypeDef:
return {
"AliasId": ...,
}
Definition
class DescribeConnectionAliasPermissionsRequestRequestTypeDef(TypedDict):
AliasId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeConnectionAliasesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasesRequestRequestTypeDef
def get_value() -> DescribeConnectionAliasesRequestRequestTypeDef:
return {
"AliasIds": ...,
}
Definition
class DescribeConnectionAliasesRequestRequestTypeDef(TypedDict):
AliasIds: NotRequired[Sequence[str]],
ResourceId: NotRequired[str],
Limit: NotRequired[int],
NextToken: NotRequired[str],
DescribeIpGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeIpGroupsRequestRequestTypeDef
def get_value() -> DescribeIpGroupsRequestRequestTypeDef:
return {
"GroupIds": ...,
}
Definition
class DescribeIpGroupsRequestRequestTypeDef(TypedDict):
GroupIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeTagsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeTagsRequestRequestTypeDef
def get_value() -> DescribeTagsRequestRequestTypeDef:
return {
"ResourceId": ...,
}
DescribeWorkspaceBundlesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesRequestRequestTypeDef
def get_value() -> DescribeWorkspaceBundlesRequestRequestTypeDef:
return {
"BundleIds": ...,
}
Definition
class DescribeWorkspaceBundlesRequestRequestTypeDef(TypedDict):
BundleIds: NotRequired[Sequence[str]],
Owner: NotRequired[str],
NextToken: NotRequired[str],
DescribeWorkspaceDirectoriesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesRequestRequestTypeDef
def get_value() -> DescribeWorkspaceDirectoriesRequestRequestTypeDef:
return {
"DirectoryIds": ...,
}
Definition
class DescribeWorkspaceDirectoriesRequestRequestTypeDef(TypedDict):
DirectoryIds: NotRequired[Sequence[str]],
Limit: NotRequired[int],
NextToken: NotRequired[str],
DescribeWorkspaceImagePermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagePermissionsRequestRequestTypeDef
def get_value() -> DescribeWorkspaceImagePermissionsRequestRequestTypeDef:
return {
"ImageId": ...,
}
Definition
class DescribeWorkspaceImagePermissionsRequestRequestTypeDef(TypedDict):
ImageId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ImagePermissionTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ImagePermissionTypeDef
def get_value() -> ImagePermissionTypeDef:
return {
"SharedAccountId": ...,
}
DescribeWorkspaceImagesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesRequestRequestTypeDef
def get_value() -> DescribeWorkspaceImagesRequestRequestTypeDef:
return {
"ImageIds": ...,
}
Definition
class DescribeWorkspaceImagesRequestRequestTypeDef(TypedDict):
ImageIds: NotRequired[Sequence[str]],
ImageType: NotRequired[ImageTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See ImageTypeType
DescribeWorkspaceSnapshotsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceSnapshotsRequestRequestTypeDef
def get_value() -> DescribeWorkspaceSnapshotsRequestRequestTypeDef:
return {
"WorkspaceId": ...,
}
SnapshotTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import SnapshotTypeDef
def get_value() -> SnapshotTypeDef:
return {
"SnapshotTime": ...,
}
DescribeWorkspacesConnectionStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusRequestRequestTypeDef
def get_value() -> DescribeWorkspacesConnectionStatusRequestRequestTypeDef:
return {
"WorkspaceIds": ...,
}
Definition
class DescribeWorkspacesConnectionStatusRequestRequestTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
WorkspaceConnectionStatusTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceConnectionStatusTypeDef
def get_value() -> WorkspaceConnectionStatusTypeDef:
return {
"WorkspaceId": ...,
}
Definition
class WorkspaceConnectionStatusTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
ConnectionState: NotRequired[ConnectionStateType], # (1)
ConnectionStateCheckTimestamp: NotRequired[datetime],
LastKnownUserConnectionTimestamp: NotRequired[datetime],
DescribeWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesRequestRequestTypeDef
def get_value() -> DescribeWorkspacesRequestRequestTypeDef:
return {
"WorkspaceIds": ...,
}
Definition
class DescribeWorkspacesRequestRequestTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
DirectoryId: NotRequired[str],
UserName: NotRequired[str],
BundleId: NotRequired[str],
Limit: NotRequired[int],
NextToken: NotRequired[str],
DisassociateConnectionAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DisassociateConnectionAliasRequestRequestTypeDef
def get_value() -> DisassociateConnectionAliasRequestRequestTypeDef:
return {
"AliasId": ...,
}
DisassociateIpGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DisassociateIpGroupsRequestRequestTypeDef
def get_value() -> DisassociateIpGroupsRequestRequestTypeDef:
return {
"DirectoryId": ...,
"GroupIds": ...,
}
Definition
class DisassociateIpGroupsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
GroupIds: Sequence[str],
FailedWorkspaceChangeRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import FailedWorkspaceChangeRequestTypeDef
def get_value() -> FailedWorkspaceChangeRequestTypeDef:
return {
"WorkspaceId": ...,
}
Definition
class FailedWorkspaceChangeRequestTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
IosImportClientBrandingAttributesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import IosImportClientBrandingAttributesTypeDef
def get_value() -> IosImportClientBrandingAttributesTypeDef:
return {
"Logo": ...,
}
Definition
class IosImportClientBrandingAttributesTypeDef(TypedDict):
Logo: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
Logo2x: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
Logo3x: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
SupportEmail: NotRequired[str],
SupportLink: NotRequired[str],
ForgotPasswordLink: NotRequired[str],
LoginMessage: NotRequired[Mapping[str, str]],
ListAvailableManagementCidrRangesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesRequestRequestTypeDef
def get_value() -> ListAvailableManagementCidrRangesRequestRequestTypeDef:
return {
"ManagementCidrRangeConstraint": ...,
}
Definition
class ListAvailableManagementCidrRangesRequestRequestTypeDef(TypedDict):
ManagementCidrRangeConstraint: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MigrateWorkspaceRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import MigrateWorkspaceRequestRequestTypeDef
def get_value() -> MigrateWorkspaceRequestRequestTypeDef:
return {
"SourceWorkspaceId": ...,
"BundleId": ...,
}
Definition
class MigrateWorkspaceRequestRequestTypeDef(TypedDict):
SourceWorkspaceId: str,
BundleId: str,
ModificationStateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModificationStateTypeDef
def get_value() -> ModificationStateTypeDef:
return {
"Resource": ...,
}
Definition
class ModificationStateTypeDef(TypedDict):
Resource: NotRequired[ModificationResourceEnumType], # (1)
State: NotRequired[ModificationStateEnumType], # (2)
ModifyAccountRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyAccountRequestRequestTypeDef
def get_value() -> ModifyAccountRequestRequestTypeDef:
return {
"DedicatedTenancySupport": ...,
}
Definition
class ModifyAccountRequestRequestTypeDef(TypedDict):
DedicatedTenancySupport: NotRequired[DedicatedTenancySupportEnumType], # (1)
DedicatedTenancyManagementCidrRange: NotRequired[str],
SamlPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import SamlPropertiesTypeDef
def get_value() -> SamlPropertiesTypeDef:
return {
"Status": ...,
}
Definition
class SamlPropertiesTypeDef(TypedDict):
Status: NotRequired[SamlStatusEnumType], # (1)
UserAccessUrl: NotRequired[str],
RelayStateParameterName: NotRequired[str],
SelfservicePermissionsTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import SelfservicePermissionsTypeDef
def get_value() -> SelfservicePermissionsTypeDef:
return {
"RestartWorkspace": ...,
}
Definition
class SelfservicePermissionsTypeDef(TypedDict):
RestartWorkspace: NotRequired[ReconnectEnumType], # (1)
IncreaseVolumeSize: NotRequired[ReconnectEnumType], # (1)
ChangeComputeType: NotRequired[ReconnectEnumType], # (1)
SwitchRunningMode: NotRequired[ReconnectEnumType], # (1)
RebuildWorkspace: NotRequired[ReconnectEnumType], # (1)
- See ReconnectEnumType
- See ReconnectEnumType
- See ReconnectEnumType
- See ReconnectEnumType
- See ReconnectEnumType
WorkspaceAccessPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceAccessPropertiesTypeDef
def get_value() -> WorkspaceAccessPropertiesTypeDef:
return {
"DeviceTypeWindows": ...,
}
Definition
class WorkspaceAccessPropertiesTypeDef(TypedDict):
DeviceTypeWindows: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeOsx: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeWeb: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeIos: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeAndroid: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeChromeOs: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeZeroClient: NotRequired[AccessPropertyValueType], # (1)
DeviceTypeLinux: NotRequired[AccessPropertyValueType], # (1)
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
- See AccessPropertyValueType
WorkspaceCreationPropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceCreationPropertiesTypeDef
def get_value() -> WorkspaceCreationPropertiesTypeDef:
return {
"EnableWorkDocs": ...,
}
Definition
class WorkspaceCreationPropertiesTypeDef(TypedDict):
EnableWorkDocs: NotRequired[bool],
EnableInternetAccess: NotRequired[bool],
DefaultOu: NotRequired[str],
CustomSecurityGroupId: NotRequired[str],
UserEnabledAsLocalAdministrator: NotRequired[bool],
EnableMaintenanceMode: NotRequired[bool],
WorkspacePropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspacePropertiesTypeDef
def get_value() -> WorkspacePropertiesTypeDef:
return {
"RunningMode": ...,
}
Definition
class WorkspacePropertiesTypeDef(TypedDict):
RunningMode: NotRequired[RunningModeType], # (1)
RunningModeAutoStopTimeoutInMinutes: NotRequired[int],
RootVolumeSizeGib: NotRequired[int],
UserVolumeSizeGib: NotRequired[int],
ComputeTypeName: NotRequired[ComputeType], # (2)
Protocols: NotRequired[Sequence[ProtocolType]], # (3)
- See RunningModeType
- See ComputeType
- See ProtocolType
ModifyWorkspaceStateRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyWorkspaceStateRequestRequestTypeDef
def get_value() -> ModifyWorkspaceStateRequestRequestTypeDef:
return {
"WorkspaceId": ...,
"WorkspaceState": ...,
}
Definition
class ModifyWorkspaceStateRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
WorkspaceState: TargetWorkspaceStateType, # (1)
RebootRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebootRequestTypeDef
def get_value() -> RebootRequestTypeDef:
return {
"WorkspaceId": ...,
}
RebuildRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebuildRequestTypeDef
def get_value() -> RebuildRequestTypeDef:
return {
"WorkspaceId": ...,
}
RelatedWorkspacePropertiesTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RelatedWorkspacePropertiesTypeDef
def get_value() -> RelatedWorkspacePropertiesTypeDef:
return {
"WorkspaceId": ...,
}
Definition
class RelatedWorkspacePropertiesTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
Region: NotRequired[str],
State: NotRequired[WorkspaceStateType], # (1)
Type: NotRequired[StandbyWorkspaceRelationshipTypeType], # (2)
RestoreWorkspaceRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RestoreWorkspaceRequestRequestTypeDef
def get_value() -> RestoreWorkspaceRequestRequestTypeDef:
return {
"WorkspaceId": ...,
}
RevokeIpRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RevokeIpRulesRequestRequestTypeDef
def get_value() -> RevokeIpRulesRequestRequestTypeDef:
return {
"GroupId": ...,
"UserRules": ...,
}
Definition
class RevokeIpRulesRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[str],
StartRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StartRequestTypeDef
def get_value() -> StartRequestTypeDef:
return {
"WorkspaceId": ...,
}
StopRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StopRequestTypeDef
def get_value() -> StopRequestTypeDef:
return {
"WorkspaceId": ...,
}
TerminateRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import TerminateRequestTypeDef
def get_value() -> TerminateRequestTypeDef:
return {
"WorkspaceId": ...,
}
UpdateConnectClientAddInRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateConnectClientAddInRequestRequestTypeDef
def get_value() -> UpdateConnectClientAddInRequestRequestTypeDef:
return {
"AddInId": ...,
"ResourceId": ...,
}
Definition
class UpdateConnectClientAddInRequestRequestTypeDef(TypedDict):
AddInId: str,
ResourceId: str,
Name: NotRequired[str],
URL: NotRequired[str],
UpdateResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateResultTypeDef
def get_value() -> UpdateResultTypeDef:
return {
"UpdateAvailable": ...,
}
Definition
class UpdateResultTypeDef(TypedDict):
UpdateAvailable: NotRequired[bool],
Description: NotRequired[str],
UpdateWorkspaceBundleRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateWorkspaceBundleRequestRequestTypeDef
def get_value() -> UpdateWorkspaceBundleRequestRequestTypeDef:
return {
"BundleId": ...,
}
Definition
class UpdateWorkspaceBundleRequestRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
ImageId: NotRequired[str],
UpdateWorkspaceImagePermissionRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateWorkspaceImagePermissionRequestRequestTypeDef
def get_value() -> UpdateWorkspaceImagePermissionRequestRequestTypeDef:
return {
"ImageId": ...,
"AllowCopyImage": ...,
"SharedAccountId": ...,
}
Definition
class UpdateWorkspaceImagePermissionRequestRequestTypeDef(TypedDict):
ImageId: str,
AllowCopyImage: bool,
SharedAccountId: str,
AssociateConnectionAliasResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import AssociateConnectionAliasResultTypeDef
def get_value() -> AssociateConnectionAliasResultTypeDef:
return {
"ConnectionIdentifier": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateConnectionAliasResultTypeDef(TypedDict):
ConnectionIdentifier: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CopyWorkspaceImageResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CopyWorkspaceImageResultTypeDef
def get_value() -> CopyWorkspaceImageResultTypeDef:
return {
"ImageId": ...,
"ResponseMetadata": ...,
}
Definition
class CopyWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateConnectClientAddInResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateConnectClientAddInResultTypeDef
def get_value() -> CreateConnectClientAddInResultTypeDef:
return {
"AddInId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConnectClientAddInResultTypeDef(TypedDict):
AddInId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateConnectionAliasResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateConnectionAliasResultTypeDef
def get_value() -> CreateConnectionAliasResultTypeDef:
return {
"AliasId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConnectionAliasResultTypeDef(TypedDict):
AliasId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIpGroupResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateIpGroupResultTypeDef
def get_value() -> CreateIpGroupResultTypeDef:
return {
"GroupId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateIpGroupResultTypeDef(TypedDict):
GroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUpdatedWorkspaceImageResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateUpdatedWorkspaceImageResultTypeDef
def get_value() -> CreateUpdatedWorkspaceImageResultTypeDef:
return {
"ImageId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUpdatedWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAccountModificationsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsResultTypeDef
def get_value() -> DescribeAccountModificationsResultTypeDef:
return {
"AccountModifications": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAccountModificationsResultTypeDef(TypedDict):
AccountModifications: List[AccountModificationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccountResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeAccountResultTypeDef
def get_value() -> DescribeAccountResultTypeDef:
return {
"DedicatedTenancySupport": ...,
"DedicatedTenancyManagementCidrRange": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAccountResultTypeDef(TypedDict):
DedicatedTenancySupport: DedicatedTenancySupportResultEnumType, # (1)
DedicatedTenancyManagementCidrRange: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportWorkspaceImageResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ImportWorkspaceImageResultTypeDef
def get_value() -> ImportWorkspaceImageResultTypeDef:
return {
"ImageId": ...,
"ResponseMetadata": ...,
}
Definition
class ImportWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAvailableManagementCidrRangesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesResultTypeDef
def get_value() -> ListAvailableManagementCidrRangesResultTypeDef:
return {
"ManagementCidrRanges": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAvailableManagementCidrRangesResultTypeDef(TypedDict):
ManagementCidrRanges: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MigrateWorkspaceResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import MigrateWorkspaceResultTypeDef
def get_value() -> MigrateWorkspaceResultTypeDef:
return {
"SourceWorkspaceId": ...,
"TargetWorkspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class MigrateWorkspaceResultTypeDef(TypedDict):
SourceWorkspaceId: str,
TargetWorkspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AuthorizeIpRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import AuthorizeIpRulesRequestRequestTypeDef
def get_value() -> AuthorizeIpRulesRequestRequestTypeDef:
return {
"GroupId": ...,
"UserRules": ...,
}
Definition
class AuthorizeIpRulesRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[IpRuleItemTypeDef], # (1)
UpdateRulesOfIpGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateRulesOfIpGroupRequestRequestTypeDef
def get_value() -> UpdateRulesOfIpGroupRequestRequestTypeDef:
return {
"GroupId": ...,
"UserRules": ...,
}
Definition
class UpdateRulesOfIpGroupRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[IpRuleItemTypeDef], # (1)
WorkspacesIpGroupTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspacesIpGroupTypeDef
def get_value() -> WorkspacesIpGroupTypeDef:
return {
"groupId": ...,
}
Definition
class WorkspacesIpGroupTypeDef(TypedDict):
groupId: NotRequired[str],
groupName: NotRequired[str],
groupDesc: NotRequired[str],
userRules: NotRequired[List[IpRuleItemTypeDef]], # (1)
ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef
def get_value() -> ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef:
return {
"ResourceId": ...,
}
Definition
class ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
CertificateBasedAuthProperties: NotRequired[CertificateBasedAuthPropertiesTypeDef], # (1)
PropertiesToDelete: NotRequired[Sequence[DeletableCertificateBasedAuthPropertyType]], # (2)
ClientPropertiesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ClientPropertiesResultTypeDef
def get_value() -> ClientPropertiesResultTypeDef:
return {
"ResourceId": ...,
}
Definition
class ClientPropertiesResultTypeDef(TypedDict):
ResourceId: NotRequired[str],
ClientProperties: NotRequired[ClientPropertiesTypeDef], # (1)
ModifyClientPropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyClientPropertiesRequestRequestTypeDef
def get_value() -> ModifyClientPropertiesRequestRequestTypeDef:
return {
"ResourceId": ...,
"ClientProperties": ...,
}
Definition
class ModifyClientPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
ClientProperties: ClientPropertiesTypeDef, # (1)
DescribeConnectClientAddInsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectClientAddInsResultTypeDef
def get_value() -> DescribeConnectClientAddInsResultTypeDef:
return {
"AddIns": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeConnectClientAddInsResultTypeDef(TypedDict):
AddIns: List[ConnectClientAddInTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConnectionAliasTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ConnectionAliasTypeDef
def get_value() -> ConnectionAliasTypeDef:
return {
"ConnectionString": ...,
}
Definition
class ConnectionAliasTypeDef(TypedDict):
ConnectionString: NotRequired[str],
AliasId: NotRequired[str],
State: NotRequired[ConnectionAliasStateType], # (1)
OwnerAccountId: NotRequired[str],
Associations: NotRequired[List[ConnectionAliasAssociationTypeDef]], # (2)
DescribeConnectionAliasPermissionsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasPermissionsResultTypeDef
def get_value() -> DescribeConnectionAliasPermissionsResultTypeDef:
return {
"AliasId": ...,
"ConnectionAliasPermissions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeConnectionAliasPermissionsResultTypeDef(TypedDict):
AliasId: str,
ConnectionAliasPermissions: List[ConnectionAliasPermissionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConnectionAliasPermissionRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import UpdateConnectionAliasPermissionRequestRequestTypeDef
def get_value() -> UpdateConnectionAliasPermissionRequestRequestTypeDef:
return {
"AliasId": ...,
"ConnectionAliasPermission": ...,
}
Definition
class UpdateConnectionAliasPermissionRequestRequestTypeDef(TypedDict):
AliasId: str,
ConnectionAliasPermission: ConnectionAliasPermissionTypeDef, # (1)
CopyWorkspaceImageRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CopyWorkspaceImageRequestRequestTypeDef
def get_value() -> CopyWorkspaceImageRequestRequestTypeDef:
return {
"Name": ...,
"SourceImageId": ...,
"SourceRegion": ...,
}
Definition
class CopyWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
SourceImageId: str,
SourceRegion: str,
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateConnectionAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateConnectionAliasRequestRequestTypeDef
def get_value() -> CreateConnectionAliasRequestRequestTypeDef:
return {
"ConnectionString": ...,
}
Definition
class CreateConnectionAliasRequestRequestTypeDef(TypedDict):
ConnectionString: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateIpGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateIpGroupRequestRequestTypeDef
def get_value() -> CreateIpGroupRequestRequestTypeDef:
return {
"GroupName": ...,
}
Definition
class CreateIpGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
GroupDesc: NotRequired[str],
UserRules: NotRequired[Sequence[IpRuleItemTypeDef]], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See IpRuleItemTypeDef
- See TagTypeDef
CreateTagsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateTagsRequestRequestTypeDef
def get_value() -> CreateTagsRequestRequestTypeDef:
return {
"ResourceId": ...,
"Tags": ...,
}
Definition
class CreateTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateUpdatedWorkspaceImageRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateUpdatedWorkspaceImageRequestRequestTypeDef
def get_value() -> CreateUpdatedWorkspaceImageRequestRequestTypeDef:
return {
"Name": ...,
"Description": ...,
"SourceImageId": ...,
}
Definition
class CreateUpdatedWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
Description: str,
SourceImageId: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateWorkspaceImageRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspaceImageRequestRequestTypeDef
def get_value() -> CreateWorkspaceImageRequestRequestTypeDef:
return {
"Name": ...,
"Description": ...,
"WorkspaceId": ...,
}
Definition
class CreateWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
Description: str,
WorkspaceId: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
DescribeTagsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeTagsResultTypeDef
def get_value() -> DescribeTagsResultTypeDef:
return {
"TagList": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTagsResultTypeDef(TypedDict):
TagList: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ImportWorkspaceImageRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ImportWorkspaceImageRequestRequestTypeDef
def get_value() -> ImportWorkspaceImageRequestRequestTypeDef:
return {
"Ec2ImageId": ...,
"IngestionProcess": ...,
"ImageName": ...,
"ImageDescription": ...,
}
Definition
class ImportWorkspaceImageRequestRequestTypeDef(TypedDict):
Ec2ImageId: str,
IngestionProcess: WorkspaceImageIngestionProcessType, # (1)
ImageName: str,
ImageDescription: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
Applications: NotRequired[Sequence[ApplicationType]], # (3)
RegisterWorkspaceDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RegisterWorkspaceDirectoryRequestRequestTypeDef
def get_value() -> RegisterWorkspaceDirectoryRequestRequestTypeDef:
return {
"DirectoryId": ...,
"EnableWorkDocs": ...,
}
Definition
class RegisterWorkspaceDirectoryRequestRequestTypeDef(TypedDict):
DirectoryId: str,
EnableWorkDocs: bool,
SubnetIds: NotRequired[Sequence[str]],
EnableSelfService: NotRequired[bool],
Tenancy: NotRequired[TenancyType], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See TenancyType
- See TagTypeDef
StandbyWorkspaceTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StandbyWorkspaceTypeDef
def get_value() -> StandbyWorkspaceTypeDef:
return {
"PrimaryWorkspaceId": ...,
"DirectoryId": ...,
}
Definition
class StandbyWorkspaceTypeDef(TypedDict):
PrimaryWorkspaceId: str,
DirectoryId: str,
VolumeEncryptionKey: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateWorkspaceBundleRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspaceBundleRequestRequestTypeDef
def get_value() -> CreateWorkspaceBundleRequestRequestTypeDef:
return {
"BundleName": ...,
"BundleDescription": ...,
"ImageId": ...,
"ComputeType": ...,
"UserStorage": ...,
}
Definition
class CreateWorkspaceBundleRequestRequestTypeDef(TypedDict):
BundleName: str,
BundleDescription: str,
ImageId: str,
ComputeType: ComputeTypeTypeDef, # (1)
UserStorage: UserStorageTypeDef, # (2)
RootStorage: NotRequired[RootStorageTypeDef], # (3)
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
- See ComputeTypeTypeDef
- See UserStorageTypeDef
- See RootStorageTypeDef
- See TagTypeDef
WorkspaceBundleTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceBundleTypeDef
def get_value() -> WorkspaceBundleTypeDef:
return {
"BundleId": ...,
}
Definition
class WorkspaceBundleTypeDef(TypedDict):
BundleId: NotRequired[str],
Name: NotRequired[str],
Owner: NotRequired[str],
Description: NotRequired[str],
ImageId: NotRequired[str],
RootStorage: NotRequired[RootStorageTypeDef], # (1)
UserStorage: NotRequired[UserStorageTypeDef], # (2)
ComputeType: NotRequired[ComputeTypeTypeDef], # (3)
LastUpdatedTime: NotRequired[datetime],
CreationTime: NotRequired[datetime],
State: NotRequired[WorkspaceBundleStateType], # (4)
BundleType: NotRequired[BundleTypeType], # (5)
- See RootStorageTypeDef
- See UserStorageTypeDef
- See ComputeTypeTypeDef
- See WorkspaceBundleStateType
- See BundleTypeType
CreateWorkspaceImageResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspaceImageResultTypeDef
def get_value() -> CreateWorkspaceImageResultTypeDef:
return {
"ImageId": ...,
"Name": ...,
"Description": ...,
"OperatingSystem": ...,
"State": ...,
"RequiredTenancy": ...,
"Created": ...,
"OwnerAccountId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
Name: str,
Description: str,
OperatingSystem: OperatingSystemTypeDef, # (1)
State: WorkspaceImageStateType, # (2)
RequiredTenancy: WorkspaceImageRequiredTenancyType, # (3)
Created: datetime,
OwnerAccountId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See OperatingSystemTypeDef
- See WorkspaceImageStateType
- See WorkspaceImageRequiredTenancyType
- See ResponseMetadataTypeDef
DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef
def get_value() -> DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef
def get_value() -> DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef:
return {
"GroupIds": ...,
}
Definition
class DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef(TypedDict):
GroupIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef
def get_value() -> DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef:
return {
"BundleIds": ...,
}
Definition
class DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef(TypedDict):
BundleIds: NotRequired[Sequence[str]],
Owner: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef
def get_value() -> DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef:
return {
"DirectoryIds": ...,
}
Definition
class DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef(TypedDict):
DirectoryIds: NotRequired[Sequence[str]],
Limit: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef
def get_value() -> DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef:
return {
"ImageIds": ...,
}
Definition
class DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef(TypedDict):
ImageIds: NotRequired[Sequence[str]],
ImageType: NotRequired[ImageTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See ImageTypeType
- See PaginatorConfigTypeDef
DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef
def get_value() -> DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef:
return {
"WorkspaceIds": ...,
}
Definition
class DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef
def get_value() -> DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef:
return {
"WorkspaceIds": ...,
}
Definition
class DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
DirectoryId: NotRequired[str],
UserName: NotRequired[str],
BundleId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef
def get_value() -> ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef:
return {
"ManagementCidrRangeConstraint": ...,
}
Definition
class ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef(TypedDict):
ManagementCidrRangeConstraint: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeClientBrandingResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeClientBrandingResultTypeDef
def get_value() -> DescribeClientBrandingResultTypeDef:
return {
"DeviceTypeWindows": ...,
"DeviceTypeOsx": ...,
"DeviceTypeAndroid": ...,
"DeviceTypeIos": ...,
"DeviceTypeLinux": ...,
"DeviceTypeWeb": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeClientBrandingResultTypeDef(TypedDict):
DeviceTypeWindows: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeOsx: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeAndroid: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeIos: IosClientBrandingAttributesTypeDef, # (4)
DeviceTypeLinux: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeWeb: DefaultClientBrandingAttributesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See IosClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See ResponseMetadataTypeDef
ImportClientBrandingResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ImportClientBrandingResultTypeDef
def get_value() -> ImportClientBrandingResultTypeDef:
return {
"DeviceTypeWindows": ...,
"DeviceTypeOsx": ...,
"DeviceTypeAndroid": ...,
"DeviceTypeIos": ...,
"DeviceTypeLinux": ...,
"DeviceTypeWeb": ...,
"ResponseMetadata": ...,
}
Definition
class ImportClientBrandingResultTypeDef(TypedDict):
DeviceTypeWindows: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeOsx: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeAndroid: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeIos: IosClientBrandingAttributesTypeDef, # (4)
DeviceTypeLinux: DefaultClientBrandingAttributesTypeDef, # (1)
DeviceTypeWeb: DefaultClientBrandingAttributesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See IosClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See DefaultClientBrandingAttributesTypeDef
- See ResponseMetadataTypeDef
DescribeWorkspaceImagePermissionsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagePermissionsResultTypeDef
def get_value() -> DescribeWorkspaceImagePermissionsResultTypeDef:
return {
"ImageId": ...,
"ImagePermissions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspaceImagePermissionsResultTypeDef(TypedDict):
ImageId: str,
ImagePermissions: List[ImagePermissionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceSnapshotsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceSnapshotsResultTypeDef
def get_value() -> DescribeWorkspaceSnapshotsResultTypeDef:
return {
"RebuildSnapshots": ...,
"RestoreSnapshots": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspaceSnapshotsResultTypeDef(TypedDict):
RebuildSnapshots: List[SnapshotTypeDef], # (1)
RestoreSnapshots: List[SnapshotTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See SnapshotTypeDef
- See SnapshotTypeDef
- See ResponseMetadataTypeDef
DescribeWorkspacesConnectionStatusResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusResultTypeDef
def get_value() -> DescribeWorkspacesConnectionStatusResultTypeDef:
return {
"WorkspacesConnectionStatus": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspacesConnectionStatusResultTypeDef(TypedDict):
WorkspacesConnectionStatus: List[WorkspaceConnectionStatusTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RebootWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebootWorkspacesResultTypeDef
def get_value() -> RebootWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"ResponseMetadata": ...,
}
Definition
class RebootWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RebuildWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebuildWorkspacesResultTypeDef
def get_value() -> RebuildWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"ResponseMetadata": ...,
}
Definition
class RebuildWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StartWorkspacesResultTypeDef
def get_value() -> StartWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"ResponseMetadata": ...,
}
Definition
class StartWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StopWorkspacesResultTypeDef
def get_value() -> StopWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"ResponseMetadata": ...,
}
Definition
class StopWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TerminateWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import TerminateWorkspacesResultTypeDef
def get_value() -> TerminateWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"ResponseMetadata": ...,
}
Definition
class TerminateWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportClientBrandingRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ImportClientBrandingRequestRequestTypeDef
def get_value() -> ImportClientBrandingRequestRequestTypeDef:
return {
"ResourceId": ...,
}
Definition
class ImportClientBrandingRequestRequestTypeDef(TypedDict):
ResourceId: str,
DeviceTypeWindows: NotRequired[DefaultImportClientBrandingAttributesTypeDef], # (1)
DeviceTypeOsx: NotRequired[DefaultImportClientBrandingAttributesTypeDef], # (1)
DeviceTypeAndroid: NotRequired[DefaultImportClientBrandingAttributesTypeDef], # (1)
DeviceTypeIos: NotRequired[IosImportClientBrandingAttributesTypeDef], # (4)
DeviceTypeLinux: NotRequired[DefaultImportClientBrandingAttributesTypeDef], # (1)
DeviceTypeWeb: NotRequired[DefaultImportClientBrandingAttributesTypeDef], # (1)
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See IosImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
ModifySamlPropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifySamlPropertiesRequestRequestTypeDef
def get_value() -> ModifySamlPropertiesRequestRequestTypeDef:
return {
"ResourceId": ...,
}
Definition
class ModifySamlPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
SamlProperties: NotRequired[SamlPropertiesTypeDef], # (1)
PropertiesToDelete: NotRequired[Sequence[DeletableSamlPropertyType]], # (2)
ModifySelfservicePermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifySelfservicePermissionsRequestRequestTypeDef
def get_value() -> ModifySelfservicePermissionsRequestRequestTypeDef:
return {
"ResourceId": ...,
"SelfservicePermissions": ...,
}
Definition
class ModifySelfservicePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
SelfservicePermissions: SelfservicePermissionsTypeDef, # (1)
ModifyWorkspaceAccessPropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyWorkspaceAccessPropertiesRequestRequestTypeDef
def get_value() -> ModifyWorkspaceAccessPropertiesRequestRequestTypeDef:
return {
"ResourceId": ...,
"WorkspaceAccessProperties": ...,
}
Definition
class ModifyWorkspaceAccessPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
WorkspaceAccessProperties: WorkspaceAccessPropertiesTypeDef, # (1)
WorkspaceDirectoryTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceDirectoryTypeDef
def get_value() -> WorkspaceDirectoryTypeDef:
return {
"DirectoryId": ...,
}
Definition
class WorkspaceDirectoryTypeDef(TypedDict):
DirectoryId: NotRequired[str],
Alias: NotRequired[str],
DirectoryName: NotRequired[str],
RegistrationCode: NotRequired[str],
SubnetIds: NotRequired[List[str]],
DnsIpAddresses: NotRequired[List[str]],
CustomerUserName: NotRequired[str],
IamRoleId: NotRequired[str],
DirectoryType: NotRequired[WorkspaceDirectoryTypeType], # (1)
WorkspaceSecurityGroupId: NotRequired[str],
State: NotRequired[WorkspaceDirectoryStateType], # (2)
WorkspaceCreationProperties: NotRequired[DefaultWorkspaceCreationPropertiesTypeDef], # (3)
ipGroupIds: NotRequired[List[str]],
WorkspaceAccessProperties: NotRequired[WorkspaceAccessPropertiesTypeDef], # (4)
Tenancy: NotRequired[TenancyType], # (5)
SelfservicePermissions: NotRequired[SelfservicePermissionsTypeDef], # (6)
SamlProperties: NotRequired[SamlPropertiesTypeDef], # (7)
CertificateBasedAuthProperties: NotRequired[CertificateBasedAuthPropertiesTypeDef], # (8)
- See WorkspaceDirectoryTypeType
- See WorkspaceDirectoryStateType
- See DefaultWorkspaceCreationPropertiesTypeDef
- See WorkspaceAccessPropertiesTypeDef
- See TenancyType
- See SelfservicePermissionsTypeDef
- See SamlPropertiesTypeDef
- See CertificateBasedAuthPropertiesTypeDef
ModifyWorkspaceCreationPropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyWorkspaceCreationPropertiesRequestRequestTypeDef
def get_value() -> ModifyWorkspaceCreationPropertiesRequestRequestTypeDef:
return {
"ResourceId": ...,
"WorkspaceCreationProperties": ...,
}
Definition
class ModifyWorkspaceCreationPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
WorkspaceCreationProperties: WorkspaceCreationPropertiesTypeDef, # (1)
ModifyWorkspacePropertiesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import ModifyWorkspacePropertiesRequestRequestTypeDef
def get_value() -> ModifyWorkspacePropertiesRequestRequestTypeDef:
return {
"WorkspaceId": ...,
"WorkspaceProperties": ...,
}
Definition
class ModifyWorkspacePropertiesRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
WorkspaceProperties: WorkspacePropertiesTypeDef, # (1)
WorkspaceRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceRequestTypeDef
def get_value() -> WorkspaceRequestTypeDef:
return {
"DirectoryId": ...,
"UserName": ...,
"BundleId": ...,
}
Definition
class WorkspaceRequestTypeDef(TypedDict):
DirectoryId: str,
UserName: str,
BundleId: str,
VolumeEncryptionKey: NotRequired[str],
UserVolumeEncryptionEnabled: NotRequired[bool],
RootVolumeEncryptionEnabled: NotRequired[bool],
WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See WorkspacePropertiesTypeDef
- See TagTypeDef
RebootWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebootWorkspacesRequestRequestTypeDef
def get_value() -> RebootWorkspacesRequestRequestTypeDef:
return {
"RebootWorkspaceRequests": ...,
}
Definition
class RebootWorkspacesRequestRequestTypeDef(TypedDict):
RebootWorkspaceRequests: Sequence[RebootRequestTypeDef], # (1)
RebuildWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import RebuildWorkspacesRequestRequestTypeDef
def get_value() -> RebuildWorkspacesRequestRequestTypeDef:
return {
"RebuildWorkspaceRequests": ...,
}
Definition
class RebuildWorkspacesRequestRequestTypeDef(TypedDict):
RebuildWorkspaceRequests: Sequence[RebuildRequestTypeDef], # (1)
WorkspaceTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceTypeDef
def get_value() -> WorkspaceTypeDef:
return {
"WorkspaceId": ...,
}
Definition
class WorkspaceTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
DirectoryId: NotRequired[str],
UserName: NotRequired[str],
IpAddress: NotRequired[str],
State: NotRequired[WorkspaceStateType], # (1)
BundleId: NotRequired[str],
SubnetId: NotRequired[str],
ErrorMessage: NotRequired[str],
ErrorCode: NotRequired[str],
ComputerName: NotRequired[str],
VolumeEncryptionKey: NotRequired[str],
UserVolumeEncryptionEnabled: NotRequired[bool],
RootVolumeEncryptionEnabled: NotRequired[bool],
WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef], # (2)
ModificationStates: NotRequired[List[ModificationStateTypeDef]], # (3)
RelatedWorkspaces: NotRequired[List[RelatedWorkspacePropertiesTypeDef]], # (4)
- See WorkspaceStateType
- See WorkspacePropertiesTypeDef
- See ModificationStateTypeDef
- See RelatedWorkspacePropertiesTypeDef
StartWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StartWorkspacesRequestRequestTypeDef
def get_value() -> StartWorkspacesRequestRequestTypeDef:
return {
"StartWorkspaceRequests": ...,
}
Definition
class StartWorkspacesRequestRequestTypeDef(TypedDict):
StartWorkspaceRequests: Sequence[StartRequestTypeDef], # (1)
StopWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import StopWorkspacesRequestRequestTypeDef
def get_value() -> StopWorkspacesRequestRequestTypeDef:
return {
"StopWorkspaceRequests": ...,
}
Definition
class StopWorkspacesRequestRequestTypeDef(TypedDict):
StopWorkspaceRequests: Sequence[StopRequestTypeDef], # (1)
TerminateWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import TerminateWorkspacesRequestRequestTypeDef
def get_value() -> TerminateWorkspacesRequestRequestTypeDef:
return {
"TerminateWorkspaceRequests": ...,
}
Definition
class TerminateWorkspacesRequestRequestTypeDef(TypedDict):
TerminateWorkspaceRequests: Sequence[TerminateRequestTypeDef], # (1)
WorkspaceImageTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import WorkspaceImageTypeDef
def get_value() -> WorkspaceImageTypeDef:
return {
"ImageId": ...,
}
Definition
class WorkspaceImageTypeDef(TypedDict):
ImageId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
OperatingSystem: NotRequired[OperatingSystemTypeDef], # (1)
State: NotRequired[WorkspaceImageStateType], # (2)
RequiredTenancy: NotRequired[WorkspaceImageRequiredTenancyType], # (3)
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
Created: NotRequired[datetime],
OwnerAccountId: NotRequired[str],
Updates: NotRequired[UpdateResultTypeDef], # (4)
- See OperatingSystemTypeDef
- See WorkspaceImageStateType
- See WorkspaceImageRequiredTenancyType
- See UpdateResultTypeDef
DescribeIpGroupsResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeIpGroupsResultTypeDef
def get_value() -> DescribeIpGroupsResultTypeDef:
return {
"Result": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeIpGroupsResultTypeDef(TypedDict):
Result: List[WorkspacesIpGroupTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeClientPropertiesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeClientPropertiesResultTypeDef
def get_value() -> DescribeClientPropertiesResultTypeDef:
return {
"ClientPropertiesList": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeClientPropertiesResultTypeDef(TypedDict):
ClientPropertiesList: List[ClientPropertiesResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeConnectionAliasesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasesResultTypeDef
def get_value() -> DescribeConnectionAliasesResultTypeDef:
return {
"ConnectionAliases": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeConnectionAliasesResultTypeDef(TypedDict):
ConnectionAliases: List[ConnectionAliasTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStandbyWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateStandbyWorkspacesRequestRequestTypeDef
def get_value() -> CreateStandbyWorkspacesRequestRequestTypeDef:
return {
"PrimaryRegion": ...,
"StandbyWorkspaces": ...,
}
Definition
class CreateStandbyWorkspacesRequestRequestTypeDef(TypedDict):
PrimaryRegion: str,
StandbyWorkspaces: Sequence[StandbyWorkspaceTypeDef], # (1)
FailedCreateStandbyWorkspacesRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import FailedCreateStandbyWorkspacesRequestTypeDef
def get_value() -> FailedCreateStandbyWorkspacesRequestTypeDef:
return {
"StandbyWorkspaceRequest": ...,
}
Definition
class FailedCreateStandbyWorkspacesRequestTypeDef(TypedDict):
StandbyWorkspaceRequest: NotRequired[StandbyWorkspaceTypeDef], # (1)
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
CreateWorkspaceBundleResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspaceBundleResultTypeDef
def get_value() -> CreateWorkspaceBundleResultTypeDef:
return {
"WorkspaceBundle": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWorkspaceBundleResultTypeDef(TypedDict):
WorkspaceBundle: WorkspaceBundleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceBundlesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesResultTypeDef
def get_value() -> DescribeWorkspaceBundlesResultTypeDef:
return {
"Bundles": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspaceBundlesResultTypeDef(TypedDict):
Bundles: List[WorkspaceBundleTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceDirectoriesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesResultTypeDef
def get_value() -> DescribeWorkspaceDirectoriesResultTypeDef:
return {
"Directories": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspaceDirectoriesResultTypeDef(TypedDict):
Directories: List[WorkspaceDirectoryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspacesRequestRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspacesRequestRequestTypeDef
def get_value() -> CreateWorkspacesRequestRequestTypeDef:
return {
"Workspaces": ...,
}
Definition
class CreateWorkspacesRequestRequestTypeDef(TypedDict):
Workspaces: Sequence[WorkspaceRequestTypeDef], # (1)
FailedCreateWorkspaceRequestTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import FailedCreateWorkspaceRequestTypeDef
def get_value() -> FailedCreateWorkspaceRequestTypeDef:
return {
"WorkspaceRequest": ...,
}
Definition
class FailedCreateWorkspaceRequestTypeDef(TypedDict):
WorkspaceRequest: NotRequired[WorkspaceRequestTypeDef], # (1)
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
DescribeWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspacesResultTypeDef
def get_value() -> DescribeWorkspacesResultTypeDef:
return {
"Workspaces": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspacesResultTypeDef(TypedDict):
Workspaces: List[WorkspaceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceImagesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesResultTypeDef
def get_value() -> DescribeWorkspaceImagesResultTypeDef:
return {
"Images": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeWorkspaceImagesResultTypeDef(TypedDict):
Images: List[WorkspaceImageTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStandbyWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateStandbyWorkspacesResultTypeDef
def get_value() -> CreateStandbyWorkspacesResultTypeDef:
return {
"FailedStandbyRequests": ...,
"PendingStandbyRequests": ...,
"ResponseMetadata": ...,
}
Definition
class CreateStandbyWorkspacesResultTypeDef(TypedDict):
FailedStandbyRequests: List[FailedCreateStandbyWorkspacesRequestTypeDef], # (1)
PendingStandbyRequests: List[PendingCreateStandbyWorkspacesRequestTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See FailedCreateStandbyWorkspacesRequestTypeDef
- See PendingCreateStandbyWorkspacesRequestTypeDef
- See ResponseMetadataTypeDef
CreateWorkspacesResultTypeDef
Usage Example
from mypy_boto3_workspaces.type_defs import CreateWorkspacesResultTypeDef
def get_value() -> CreateWorkspacesResultTypeDef:
return {
"FailedRequests": ...,
"PendingRequests": ...,
"ResponseMetadata": ...,
}