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,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
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],
DescribeWorkspacesRequestRequestTypeDef#
# DescribeWorkspacesRequestRequestTypeDef definition
class DescribeWorkspacesRequestRequestTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
DirectoryId: NotRequired[str],
UserName: NotRequired[str],
BundleId: NotRequired[str],
Limit: NotRequired[int],
NextToken: NotRequired[str],
WorkspaceName: NotRequired[str],
DisassociateConnectionAliasRequestRequestTypeDef#
# DisassociateConnectionAliasRequestRequestTypeDef definition
class DisassociateConnectionAliasRequestRequestTypeDef(TypedDict):
AliasId: str,
DisassociateIpGroupsRequestRequestTypeDef#
# DisassociateIpGroupsRequestRequestTypeDef definition
class DisassociateIpGroupsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
GroupIds: Sequence[str],
DisassociateWorkspaceApplicationRequestRequestTypeDef#
# DisassociateWorkspaceApplicationRequestRequestTypeDef definition
class DisassociateWorkspaceApplicationRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
ApplicationId: str,
ErrorDetailsTypeDef#
# ErrorDetailsTypeDef definition
class ErrorDetailsTypeDef(TypedDict):
ErrorCode: NotRequired[WorkspaceImageErrorDetailCodeType], # (1)
ErrorMessage: NotRequired[str],
FailedWorkspaceChangeRequestTypeDef#
# FailedWorkspaceChangeRequestTypeDef definition
class FailedWorkspaceChangeRequestTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
ListAvailableManagementCidrRangesRequestRequestTypeDef#
# ListAvailableManagementCidrRangesRequestRequestTypeDef definition
class ListAvailableManagementCidrRangesRequestRequestTypeDef(TypedDict):
ManagementCidrRangeConstraint: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MigrateWorkspaceRequestRequestTypeDef#
# MigrateWorkspaceRequestRequestTypeDef definition
class MigrateWorkspaceRequestRequestTypeDef(TypedDict):
SourceWorkspaceId: str,
BundleId: str,
ModificationStateTypeDef#
# ModificationStateTypeDef definition
class ModificationStateTypeDef(TypedDict):
Resource: NotRequired[ModificationResourceEnumType], # (1)
State: NotRequired[ModificationStateEnumType], # (2)
ModifyAccountRequestRequestTypeDef#
# ModifyAccountRequestRequestTypeDef definition
class ModifyAccountRequestRequestTypeDef(TypedDict):
DedicatedTenancySupport: NotRequired[DedicatedTenancySupportEnumType], # (1)
DedicatedTenancyManagementCidrRange: NotRequired[str],
SamlPropertiesTypeDef#
# SamlPropertiesTypeDef definition
class SamlPropertiesTypeDef(TypedDict):
Status: NotRequired[SamlStatusEnumType], # (1)
UserAccessUrl: NotRequired[str],
RelayStateParameterName: NotRequired[str],
SelfservicePermissionsTypeDef#
# SelfservicePermissionsTypeDef 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#
# WorkspaceAccessPropertiesTypeDef 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#
# WorkspaceCreationPropertiesTypeDef definition
class WorkspaceCreationPropertiesTypeDef(TypedDict):
EnableWorkDocs: NotRequired[bool],
EnableInternetAccess: NotRequired[bool],
DefaultOu: NotRequired[str],
CustomSecurityGroupId: NotRequired[str],
UserEnabledAsLocalAdministrator: NotRequired[bool],
EnableMaintenanceMode: NotRequired[bool],
WorkspacePropertiesTypeDef#
# WorkspacePropertiesTypeDef 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)
OperatingSystemName: NotRequired[OperatingSystemNameType], # (4)
- See RunningModeType
- See ComputeType
- See ProtocolType
- See OperatingSystemNameType
ModifyWorkspaceStateRequestRequestTypeDef#
# ModifyWorkspaceStateRequestRequestTypeDef definition
class ModifyWorkspaceStateRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
WorkspaceState: TargetWorkspaceStateType, # (1)
RebootRequestTypeDef#
# RebootRequestTypeDef definition
class RebootRequestTypeDef(TypedDict):
WorkspaceId: str,
RebuildRequestTypeDef#
# RebuildRequestTypeDef definition
class RebuildRequestTypeDef(TypedDict):
WorkspaceId: str,
RelatedWorkspacePropertiesTypeDef#
# RelatedWorkspacePropertiesTypeDef definition
class RelatedWorkspacePropertiesTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
Region: NotRequired[str],
State: NotRequired[WorkspaceStateType], # (1)
Type: NotRequired[StandbyWorkspaceRelationshipTypeType], # (2)
RestoreWorkspaceRequestRequestTypeDef#
# RestoreWorkspaceRequestRequestTypeDef definition
class RestoreWorkspaceRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
RevokeIpRulesRequestRequestTypeDef#
# RevokeIpRulesRequestRequestTypeDef definition
class RevokeIpRulesRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[str],
StandbyWorkspacesPropertiesTypeDef#
# StandbyWorkspacesPropertiesTypeDef definition
class StandbyWorkspacesPropertiesTypeDef(TypedDict):
StandbyWorkspaceId: NotRequired[str],
DataReplication: NotRequired[DataReplicationType], # (1)
RecoverySnapshotTime: NotRequired[datetime],
StartRequestTypeDef#
# StartRequestTypeDef definition
class StartRequestTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
StopRequestTypeDef#
# StopRequestTypeDef definition
class StopRequestTypeDef(TypedDict):
WorkspaceId: NotRequired[str],
TerminateRequestTypeDef#
# TerminateRequestTypeDef definition
class TerminateRequestTypeDef(TypedDict):
WorkspaceId: str,
UpdateConnectClientAddInRequestRequestTypeDef#
# UpdateConnectClientAddInRequestRequestTypeDef definition
class UpdateConnectClientAddInRequestRequestTypeDef(TypedDict):
AddInId: str,
ResourceId: str,
Name: NotRequired[str],
URL: NotRequired[str],
UpdateResultTypeDef#
# UpdateResultTypeDef definition
class UpdateResultTypeDef(TypedDict):
UpdateAvailable: NotRequired[bool],
Description: NotRequired[str],
UpdateWorkspaceBundleRequestRequestTypeDef#
# UpdateWorkspaceBundleRequestRequestTypeDef definition
class UpdateWorkspaceBundleRequestRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
ImageId: NotRequired[str],
UpdateWorkspaceImagePermissionRequestRequestTypeDef#
# UpdateWorkspaceImagePermissionRequestRequestTypeDef definition
class UpdateWorkspaceImagePermissionRequestRequestTypeDef(TypedDict):
ImageId: str,
AllowCopyImage: bool,
SharedAccountId: str,
WorkspacePropertiesPaginatorTypeDef#
# WorkspacePropertiesPaginatorTypeDef definition
class WorkspacePropertiesPaginatorTypeDef(TypedDict):
RunningMode: NotRequired[RunningModeType], # (1)
RunningModeAutoStopTimeoutInMinutes: NotRequired[int],
RootVolumeSizeGib: NotRequired[int],
UserVolumeSizeGib: NotRequired[int],
ComputeTypeName: NotRequired[ComputeType], # (2)
Protocols: NotRequired[List[ProtocolType]], # (3)
OperatingSystemName: NotRequired[OperatingSystemNameType], # (4)
- See RunningModeType
- See ComputeType
- See ProtocolType
- See OperatingSystemNameType
ApplicationResourceAssociationTypeDef#
# ApplicationResourceAssociationTypeDef definition
class ApplicationResourceAssociationTypeDef(TypedDict):
ApplicationId: NotRequired[str],
AssociatedResourceId: NotRequired[str],
AssociatedResourceType: NotRequired[ApplicationAssociatedResourceTypeType], # (1)
Created: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
State: NotRequired[AssociationStateType], # (2)
StateReason: NotRequired[AssociationStateReasonTypeDef], # (3)
- See ApplicationAssociatedResourceTypeType
- See AssociationStateType
- See AssociationStateReasonTypeDef
BundleResourceAssociationTypeDef#
# BundleResourceAssociationTypeDef definition
class BundleResourceAssociationTypeDef(TypedDict):
AssociatedResourceId: NotRequired[str],
AssociatedResourceType: NotRequired[BundleAssociatedResourceTypeType], # (1)
BundleId: NotRequired[str],
Created: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
State: NotRequired[AssociationStateType], # (2)
StateReason: NotRequired[AssociationStateReasonTypeDef], # (3)
ImageResourceAssociationTypeDef#
# ImageResourceAssociationTypeDef definition
class ImageResourceAssociationTypeDef(TypedDict):
AssociatedResourceId: NotRequired[str],
AssociatedResourceType: NotRequired[ImageAssociatedResourceTypeType], # (1)
Created: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ImageId: NotRequired[str],
State: NotRequired[AssociationStateType], # (2)
StateReason: NotRequired[AssociationStateReasonTypeDef], # (3)
WorkspaceResourceAssociationTypeDef#
# WorkspaceResourceAssociationTypeDef definition
class WorkspaceResourceAssociationTypeDef(TypedDict):
AssociatedResourceId: NotRequired[str],
AssociatedResourceType: NotRequired[WorkSpaceAssociatedResourceTypeType], # (1)
Created: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
State: NotRequired[AssociationStateType], # (2)
StateReason: NotRequired[AssociationStateReasonTypeDef], # (3)
WorkspaceId: NotRequired[str],
AssociateConnectionAliasResultTypeDef#
# AssociateConnectionAliasResultTypeDef definition
class AssociateConnectionAliasResultTypeDef(TypedDict):
ConnectionIdentifier: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CopyWorkspaceImageResultTypeDef#
# CopyWorkspaceImageResultTypeDef definition
class CopyWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateConnectClientAddInResultTypeDef#
# CreateConnectClientAddInResultTypeDef definition
class CreateConnectClientAddInResultTypeDef(TypedDict):
AddInId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateConnectionAliasResultTypeDef#
# CreateConnectionAliasResultTypeDef definition
class CreateConnectionAliasResultTypeDef(TypedDict):
AliasId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIpGroupResultTypeDef#
# CreateIpGroupResultTypeDef definition
class CreateIpGroupResultTypeDef(TypedDict):
GroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUpdatedWorkspaceImageResultTypeDef#
# CreateUpdatedWorkspaceImageResultTypeDef definition
class CreateUpdatedWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAccountModificationsResultTypeDef#
# DescribeAccountModificationsResultTypeDef definition
class DescribeAccountModificationsResultTypeDef(TypedDict):
AccountModifications: List[AccountModificationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccountResultTypeDef#
# DescribeAccountResultTypeDef definition
class DescribeAccountResultTypeDef(TypedDict):
DedicatedTenancySupport: DedicatedTenancySupportResultEnumType, # (1)
DedicatedTenancyManagementCidrRange: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportWorkspaceImageResultTypeDef#
# ImportWorkspaceImageResultTypeDef definition
class ImportWorkspaceImageResultTypeDef(TypedDict):
ImageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAvailableManagementCidrRangesResultTypeDef#
# ListAvailableManagementCidrRangesResultTypeDef definition
class ListAvailableManagementCidrRangesResultTypeDef(TypedDict):
ManagementCidrRanges: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MigrateWorkspaceResultTypeDef#
# MigrateWorkspaceResultTypeDef definition
class MigrateWorkspaceResultTypeDef(TypedDict):
SourceWorkspaceId: str,
TargetWorkspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AuthorizeIpRulesRequestRequestTypeDef#
# AuthorizeIpRulesRequestRequestTypeDef definition
class AuthorizeIpRulesRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[IpRuleItemTypeDef], # (1)
UpdateRulesOfIpGroupRequestRequestTypeDef#
# UpdateRulesOfIpGroupRequestRequestTypeDef definition
class UpdateRulesOfIpGroupRequestRequestTypeDef(TypedDict):
GroupId: str,
UserRules: Sequence[IpRuleItemTypeDef], # (1)
WorkspacesIpGroupTypeDef#
# WorkspacesIpGroupTypeDef definition
class WorkspacesIpGroupTypeDef(TypedDict):
groupId: NotRequired[str],
groupName: NotRequired[str],
groupDesc: NotRequired[str],
userRules: NotRequired[List[IpRuleItemTypeDef]], # (1)
DefaultImportClientBrandingAttributesTypeDef#
# DefaultImportClientBrandingAttributesTypeDef 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]],
IosImportClientBrandingAttributesTypeDef#
# IosImportClientBrandingAttributesTypeDef 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]],
ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef#
# ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef definition
class ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
CertificateBasedAuthProperties: NotRequired[CertificateBasedAuthPropertiesTypeDef], # (1)
PropertiesToDelete: NotRequired[Sequence[DeletableCertificateBasedAuthPropertyType]], # (2)
ClientPropertiesResultTypeDef#
# ClientPropertiesResultTypeDef definition
class ClientPropertiesResultTypeDef(TypedDict):
ResourceId: NotRequired[str],
ClientProperties: NotRequired[ClientPropertiesTypeDef], # (1)
ModifyClientPropertiesRequestRequestTypeDef#
# ModifyClientPropertiesRequestRequestTypeDef definition
class ModifyClientPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
ClientProperties: ClientPropertiesTypeDef, # (1)
DescribeConnectClientAddInsResultTypeDef#
# DescribeConnectClientAddInsResultTypeDef definition
class DescribeConnectClientAddInsResultTypeDef(TypedDict):
AddIns: List[ConnectClientAddInTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConnectionAliasTypeDef#
# ConnectionAliasTypeDef definition
class ConnectionAliasTypeDef(TypedDict):
ConnectionString: NotRequired[str],
AliasId: NotRequired[str],
State: NotRequired[ConnectionAliasStateType], # (1)
OwnerAccountId: NotRequired[str],
Associations: NotRequired[List[ConnectionAliasAssociationTypeDef]], # (2)
DescribeConnectionAliasPermissionsResultTypeDef#
# DescribeConnectionAliasPermissionsResultTypeDef definition
class DescribeConnectionAliasPermissionsResultTypeDef(TypedDict):
AliasId: str,
ConnectionAliasPermissions: List[ConnectionAliasPermissionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConnectionAliasPermissionRequestRequestTypeDef#
# UpdateConnectionAliasPermissionRequestRequestTypeDef definition
class UpdateConnectionAliasPermissionRequestRequestTypeDef(TypedDict):
AliasId: str,
ConnectionAliasPermission: ConnectionAliasPermissionTypeDef, # (1)
CopyWorkspaceImageRequestRequestTypeDef#
# CopyWorkspaceImageRequestRequestTypeDef definition
class CopyWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
SourceImageId: str,
SourceRegion: str,
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateConnectionAliasRequestRequestTypeDef#
# CreateConnectionAliasRequestRequestTypeDef definition
class CreateConnectionAliasRequestRequestTypeDef(TypedDict):
ConnectionString: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateIpGroupRequestRequestTypeDef#
# CreateIpGroupRequestRequestTypeDef definition
class CreateIpGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
GroupDesc: NotRequired[str],
UserRules: NotRequired[Sequence[IpRuleItemTypeDef]], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See IpRuleItemTypeDef
- See TagTypeDef
CreateTagsRequestRequestTypeDef#
# CreateTagsRequestRequestTypeDef definition
class CreateTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateUpdatedWorkspaceImageRequestRequestTypeDef#
# CreateUpdatedWorkspaceImageRequestRequestTypeDef definition
class CreateUpdatedWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
Description: str,
SourceImageId: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateWorkspaceImageRequestRequestTypeDef#
# CreateWorkspaceImageRequestRequestTypeDef definition
class CreateWorkspaceImageRequestRequestTypeDef(TypedDict):
Name: str,
Description: str,
WorkspaceId: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
DescribeTagsResultTypeDef#
# DescribeTagsResultTypeDef definition
class DescribeTagsResultTypeDef(TypedDict):
TagList: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ImportWorkspaceImageRequestRequestTypeDef#
# ImportWorkspaceImageRequestRequestTypeDef definition
class ImportWorkspaceImageRequestRequestTypeDef(TypedDict):
Ec2ImageId: str,
IngestionProcess: WorkspaceImageIngestionProcessType, # (1)
ImageName: str,
ImageDescription: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
Applications: NotRequired[Sequence[ApplicationType]], # (3)
RegisterWorkspaceDirectoryRequestRequestTypeDef#
# RegisterWorkspaceDirectoryRequestRequestTypeDef 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#
# StandbyWorkspaceTypeDef definition
class StandbyWorkspaceTypeDef(TypedDict):
PrimaryWorkspaceId: str,
DirectoryId: str,
VolumeEncryptionKey: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
DataReplication: NotRequired[DataReplicationType], # (2)
- See TagTypeDef
- See DataReplicationType
CreateWorkspaceBundleRequestRequestTypeDef#
# CreateWorkspaceBundleRequestRequestTypeDef 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#
# WorkspaceBundleTypeDef 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#
# CreateWorkspaceImageResultTypeDef 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#
# DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef definition
class DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef#
# DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef definition
class DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef(TypedDict):
GroupIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef#
# DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef definition
class DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef(TypedDict):
BundleIds: NotRequired[Sequence[str]],
Owner: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef#
# DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef definition
class DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef(TypedDict):
DirectoryIds: NotRequired[Sequence[str]],
Limit: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef#
# DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef definition
class DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef(TypedDict):
ImageIds: NotRequired[Sequence[str]],
ImageType: NotRequired[ImageTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See ImageTypeType
- See PaginatorConfigTypeDef
DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef#
# DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef definition
class DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef#
# DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef definition
class DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef(TypedDict):
WorkspaceIds: NotRequired[Sequence[str]],
DirectoryId: NotRequired[str],
UserName: NotRequired[str],
BundleId: NotRequired[str],
WorkspaceName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef#
# ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef definition
class ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef(TypedDict):
ManagementCidrRangeConstraint: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeApplicationsResultTypeDef#
# DescribeApplicationsResultTypeDef definition
class DescribeApplicationsResultTypeDef(TypedDict):
Applications: List[WorkSpaceApplicationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeClientBrandingResultTypeDef#
# DescribeClientBrandingResultTypeDef 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#
# ImportClientBrandingResultTypeDef 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#
# DescribeWorkspaceImagePermissionsResultTypeDef definition
class DescribeWorkspaceImagePermissionsResultTypeDef(TypedDict):
ImageId: str,
ImagePermissions: List[ImagePermissionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceSnapshotsResultTypeDef#
# DescribeWorkspaceSnapshotsResultTypeDef definition
class DescribeWorkspaceSnapshotsResultTypeDef(TypedDict):
RebuildSnapshots: List[SnapshotTypeDef], # (1)
RestoreSnapshots: List[SnapshotTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See SnapshotTypeDef
- See SnapshotTypeDef
- See ResponseMetadataTypeDef
DescribeWorkspacesConnectionStatusResultTypeDef#
# DescribeWorkspacesConnectionStatusResultTypeDef definition
class DescribeWorkspacesConnectionStatusResultTypeDef(TypedDict):
WorkspacesConnectionStatus: List[WorkspaceConnectionStatusTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RebootWorkspacesResultTypeDef#
# RebootWorkspacesResultTypeDef definition
class RebootWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RebuildWorkspacesResultTypeDef#
# RebuildWorkspacesResultTypeDef definition
class RebuildWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartWorkspacesResultTypeDef#
# StartWorkspacesResultTypeDef definition
class StartWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopWorkspacesResultTypeDef#
# StopWorkspacesResultTypeDef definition
class StopWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TerminateWorkspacesResultTypeDef#
# TerminateWorkspacesResultTypeDef definition
class TerminateWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedWorkspaceChangeRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifySamlPropertiesRequestRequestTypeDef#
# ModifySamlPropertiesRequestRequestTypeDef definition
class ModifySamlPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
SamlProperties: NotRequired[SamlPropertiesTypeDef], # (1)
PropertiesToDelete: NotRequired[Sequence[DeletableSamlPropertyType]], # (2)
ModifySelfservicePermissionsRequestRequestTypeDef#
# ModifySelfservicePermissionsRequestRequestTypeDef definition
class ModifySelfservicePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
SelfservicePermissions: SelfservicePermissionsTypeDef, # (1)
ModifyWorkspaceAccessPropertiesRequestRequestTypeDef#
# ModifyWorkspaceAccessPropertiesRequestRequestTypeDef definition
class ModifyWorkspaceAccessPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
WorkspaceAccessProperties: WorkspaceAccessPropertiesTypeDef, # (1)
WorkspaceDirectoryTypeDef#
# WorkspaceDirectoryTypeDef 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#
# ModifyWorkspaceCreationPropertiesRequestRequestTypeDef definition
class ModifyWorkspaceCreationPropertiesRequestRequestTypeDef(TypedDict):
ResourceId: str,
WorkspaceCreationProperties: WorkspaceCreationPropertiesTypeDef, # (1)
ModifyWorkspacePropertiesRequestRequestTypeDef#
# ModifyWorkspacePropertiesRequestRequestTypeDef definition
class ModifyWorkspacePropertiesRequestRequestTypeDef(TypedDict):
WorkspaceId: str,
WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef], # (1)
DataReplication: NotRequired[DataReplicationType], # (2)
WorkspaceRequestTypeDef#
# WorkspaceRequestTypeDef 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)
WorkspaceName: NotRequired[str],
- See WorkspacePropertiesTypeDef
- See TagTypeDef
RebootWorkspacesRequestRequestTypeDef#
# RebootWorkspacesRequestRequestTypeDef definition
class RebootWorkspacesRequestRequestTypeDef(TypedDict):
RebootWorkspaceRequests: Sequence[RebootRequestTypeDef], # (1)
RebuildWorkspacesRequestRequestTypeDef#
# RebuildWorkspacesRequestRequestTypeDef definition
class RebuildWorkspacesRequestRequestTypeDef(TypedDict):
RebuildWorkspaceRequests: Sequence[RebuildRequestTypeDef], # (1)
WorkspaceTypeDef#
# WorkspaceTypeDef 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],
WorkspaceName: NotRequired[str],
WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef], # (2)
ModificationStates: NotRequired[List[ModificationStateTypeDef]], # (3)
RelatedWorkspaces: NotRequired[List[RelatedWorkspacePropertiesTypeDef]], # (4)
DataReplicationSettings: NotRequired[DataReplicationSettingsTypeDef], # (5)
StandbyWorkspacesProperties: NotRequired[List[StandbyWorkspacesPropertiesTypeDef]], # (6)
- See WorkspaceStateType
- See WorkspacePropertiesTypeDef
- See ModificationStateTypeDef
- See RelatedWorkspacePropertiesTypeDef
- See DataReplicationSettingsTypeDef
- See StandbyWorkspacesPropertiesTypeDef
StartWorkspacesRequestRequestTypeDef#
# StartWorkspacesRequestRequestTypeDef definition
class StartWorkspacesRequestRequestTypeDef(TypedDict):
StartWorkspaceRequests: Sequence[StartRequestTypeDef], # (1)
StopWorkspacesRequestRequestTypeDef#
# StopWorkspacesRequestRequestTypeDef definition
class StopWorkspacesRequestRequestTypeDef(TypedDict):
StopWorkspaceRequests: Sequence[StopRequestTypeDef], # (1)
TerminateWorkspacesRequestRequestTypeDef#
# TerminateWorkspacesRequestRequestTypeDef definition
class TerminateWorkspacesRequestRequestTypeDef(TypedDict):
TerminateWorkspaceRequests: Sequence[TerminateRequestTypeDef], # (1)
WorkspaceImageTypeDef#
# WorkspaceImageTypeDef 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)
ErrorDetails: NotRequired[List[ErrorDetailsTypeDef]], # (5)
- See OperatingSystemTypeDef
- See WorkspaceImageStateType
- See WorkspaceImageRequiredTenancyType
- See UpdateResultTypeDef
- See ErrorDetailsTypeDef
WorkspacePaginatorTypeDef#
# WorkspacePaginatorTypeDef definition
class WorkspacePaginatorTypeDef(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],
WorkspaceName: NotRequired[str],
WorkspaceProperties: NotRequired[WorkspacePropertiesPaginatorTypeDef], # (2)
ModificationStates: NotRequired[List[ModificationStateTypeDef]], # (3)
RelatedWorkspaces: NotRequired[List[RelatedWorkspacePropertiesTypeDef]], # (4)
DataReplicationSettings: NotRequired[DataReplicationSettingsTypeDef], # (5)
StandbyWorkspacesProperties: NotRequired[List[StandbyWorkspacesPropertiesTypeDef]], # (6)
- See WorkspaceStateType
- See WorkspacePropertiesPaginatorTypeDef
- See ModificationStateTypeDef
- See RelatedWorkspacePropertiesTypeDef
- See DataReplicationSettingsTypeDef
- See StandbyWorkspacesPropertiesTypeDef
DescribeApplicationAssociationsResultTypeDef#
# DescribeApplicationAssociationsResultTypeDef definition
class DescribeApplicationAssociationsResultTypeDef(TypedDict):
Associations: List[ApplicationResourceAssociationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeBundleAssociationsResultTypeDef#
# DescribeBundleAssociationsResultTypeDef definition
class DescribeBundleAssociationsResultTypeDef(TypedDict):
Associations: List[BundleResourceAssociationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeImageAssociationsResultTypeDef#
# DescribeImageAssociationsResultTypeDef definition
class DescribeImageAssociationsResultTypeDef(TypedDict):
Associations: List[ImageResourceAssociationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociateWorkspaceApplicationResultTypeDef#
# AssociateWorkspaceApplicationResultTypeDef definition
class AssociateWorkspaceApplicationResultTypeDef(TypedDict):
Association: WorkspaceResourceAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceAssociationsResultTypeDef#
# DescribeWorkspaceAssociationsResultTypeDef definition
class DescribeWorkspaceAssociationsResultTypeDef(TypedDict):
Associations: List[WorkspaceResourceAssociationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateWorkspaceApplicationResultTypeDef#
# DisassociateWorkspaceApplicationResultTypeDef definition
class DisassociateWorkspaceApplicationResultTypeDef(TypedDict):
Association: WorkspaceResourceAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WorkSpaceApplicationDeploymentTypeDef#
# WorkSpaceApplicationDeploymentTypeDef definition
class WorkSpaceApplicationDeploymentTypeDef(TypedDict):
Associations: NotRequired[List[WorkspaceResourceAssociationTypeDef]], # (1)
DescribeIpGroupsResultTypeDef#
# DescribeIpGroupsResultTypeDef definition
class DescribeIpGroupsResultTypeDef(TypedDict):
Result: List[WorkspacesIpGroupTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportClientBrandingRequestRequestTypeDef#
# ImportClientBrandingRequestRequestTypeDef 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
DescribeClientPropertiesResultTypeDef#
# DescribeClientPropertiesResultTypeDef definition
class DescribeClientPropertiesResultTypeDef(TypedDict):
ClientPropertiesList: List[ClientPropertiesResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeConnectionAliasesResultTypeDef#
# DescribeConnectionAliasesResultTypeDef definition
class DescribeConnectionAliasesResultTypeDef(TypedDict):
ConnectionAliases: List[ConnectionAliasTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStandbyWorkspacesRequestRequestTypeDef#
# CreateStandbyWorkspacesRequestRequestTypeDef definition
class CreateStandbyWorkspacesRequestRequestTypeDef(TypedDict):
PrimaryRegion: str,
StandbyWorkspaces: Sequence[StandbyWorkspaceTypeDef], # (1)
FailedCreateStandbyWorkspacesRequestTypeDef#
# FailedCreateStandbyWorkspacesRequestTypeDef definition
class FailedCreateStandbyWorkspacesRequestTypeDef(TypedDict):
StandbyWorkspaceRequest: NotRequired[StandbyWorkspaceTypeDef], # (1)
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
CreateWorkspaceBundleResultTypeDef#
# CreateWorkspaceBundleResultTypeDef definition
class CreateWorkspaceBundleResultTypeDef(TypedDict):
WorkspaceBundle: WorkspaceBundleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceBundlesResultTypeDef#
# DescribeWorkspaceBundlesResultTypeDef definition
class DescribeWorkspaceBundlesResultTypeDef(TypedDict):
Bundles: List[WorkspaceBundleTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceDirectoriesResultTypeDef#
# DescribeWorkspaceDirectoriesResultTypeDef definition
class DescribeWorkspaceDirectoriesResultTypeDef(TypedDict):
Directories: List[WorkspaceDirectoryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspacesRequestRequestTypeDef#
# CreateWorkspacesRequestRequestTypeDef definition
class CreateWorkspacesRequestRequestTypeDef(TypedDict):
Workspaces: Sequence[WorkspaceRequestTypeDef], # (1)
FailedCreateWorkspaceRequestTypeDef#
# FailedCreateWorkspaceRequestTypeDef definition
class FailedCreateWorkspaceRequestTypeDef(TypedDict):
WorkspaceRequest: NotRequired[WorkspaceRequestTypeDef], # (1)
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
DescribeWorkspacesResultTypeDef#
# DescribeWorkspacesResultTypeDef definition
class DescribeWorkspacesResultTypeDef(TypedDict):
Workspaces: List[WorkspaceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceImagesResultTypeDef#
# DescribeWorkspaceImagesResultTypeDef definition
class DescribeWorkspaceImagesResultTypeDef(TypedDict):
Images: List[WorkspaceImageTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspacesResultPaginatorTypeDef#
# DescribeWorkspacesResultPaginatorTypeDef definition
class DescribeWorkspacesResultPaginatorTypeDef(TypedDict):
Workspaces: List[WorkspacePaginatorTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeployWorkspaceApplicationsResultTypeDef#
# DeployWorkspaceApplicationsResultTypeDef definition
class DeployWorkspaceApplicationsResultTypeDef(TypedDict):
Deployment: WorkSpaceApplicationDeploymentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStandbyWorkspacesResultTypeDef#
# CreateStandbyWorkspacesResultTypeDef definition
class CreateStandbyWorkspacesResultTypeDef(TypedDict):
FailedStandbyRequests: List[FailedCreateStandbyWorkspacesRequestTypeDef], # (1)
PendingStandbyRequests: List[PendingCreateStandbyWorkspacesRequestTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See FailedCreateStandbyWorkspacesRequestTypeDef
- See PendingCreateStandbyWorkspacesRequestTypeDef
- See ResponseMetadataTypeDef
CreateWorkspacesResultTypeDef#
# CreateWorkspacesResultTypeDef definition
class CreateWorkspacesResultTypeDef(TypedDict):
FailedRequests: List[FailedCreateWorkspaceRequestTypeDef], # (1)
PendingRequests: List[WorkspaceTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)