WorkSpaces module#
Index > WorkSpaces
Auto-generated documentation for WorkSpaces type annotations stubs module mypy-boto3-workspaces.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and WorkSpaces
.
From PyPI with pip#
Install boto3-stubs
for WorkSpaces
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[workspaces]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[workspaces]'
# standalone installation
python -m pip install mypy-boto3-workspaces
How to uninstall#
python -m pip uninstall -y mypy-boto3-workspaces
Usage#
Code samples can be found in Examples.
WorkSpacesClient#
Type annotations and code completion for boto3.client("workspaces")
as WorkSpacesClient
boto3 documentation
# WorkSpacesClient usage example
from boto3.session import Session
from mypy_boto3_workspaces.client import WorkSpacesClient
def get_client() -> WorkSpacesClient:
return Session().client("workspaces")
Paginators#
Type annotations and code completion for paginators
from boto3.client("workspaces").get_paginator("...")
.
# DescribeAccountModificationsPaginator usage example
from boto3.session import Session
from mypy_boto3_workspaces.paginator import DescribeAccountModificationsPaginator
def get_describe_account_modifications_paginator() -> DescribeAccountModificationsPaginator:
return Session().client("workspaces").get_paginator("describe_account_modifications"))
- DescribeAccountModificationsPaginator
- DescribeIpGroupsPaginator
- DescribeWorkspaceBundlesPaginator
- DescribeWorkspaceDirectoriesPaginator
- DescribeWorkspaceImagesPaginator
- DescribeWorkspacesPaginator
- DescribeWorkspacesConnectionStatusPaginator
- ListAvailableManagementCidrRangesPaginator
Literals#
Type annotations for literals used in methods and schemas.
# AccessPropertyValueType usage example
from mypy_boto3_workspaces.literals import AccessPropertyValueType
def get_value() -> AccessPropertyValueType:
return "ALLOW"
- AccessPropertyValueType
- ApplicationType
- AssociationStatusType
- BundleTypeType
- CertificateBasedAuthStatusEnumType
- ClientDeviceTypeType
- ComputeType
- ConnectionAliasStateType
- ConnectionStateType
- DedicatedTenancyModificationStateEnumType
- DedicatedTenancySupportEnumType
- DedicatedTenancySupportResultEnumType
- DeletableCertificateBasedAuthPropertyType
- DeletableSamlPropertyType
- DescribeAccountModificationsPaginatorName
- DescribeIpGroupsPaginatorName
- DescribeWorkspaceBundlesPaginatorName
- DescribeWorkspaceDirectoriesPaginatorName
- DescribeWorkspaceImagesPaginatorName
- DescribeWorkspacesConnectionStatusPaginatorName
- DescribeWorkspacesPaginatorName
- ImageTypeType
- ListAvailableManagementCidrRangesPaginatorName
- LogUploadEnumType
- ModificationResourceEnumType
- ModificationStateEnumType
- OperatingSystemTypeType
- ProtocolType
- ReconnectEnumType
- RunningModeType
- SamlStatusEnumType
- StandbyWorkspaceRelationshipTypeType
- TargetWorkspaceStateType
- TenancyType
- WorkspaceBundleStateType
- WorkspaceDirectoryStateType
- WorkspaceDirectoryTypeType
- WorkspaceImageIngestionProcessType
- WorkspaceImageRequiredTenancyType
- WorkspaceImageStateType
- WorkspaceStateType
- WorkSpacesServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AccountModificationTypeDef usage example
from mypy_boto3_workspaces.type_defs import AccountModificationTypeDef
def get_value() -> AccountModificationTypeDef:
return {
"ModificationState": ...,
}
- AccountModificationTypeDef
- AssociateConnectionAliasRequestRequestTypeDef
- AssociateConnectionAliasResultTypeDef
- AssociateIpGroupsRequestRequestTypeDef
- IpRuleItemTypeDef
- CertificateBasedAuthPropertiesTypeDef
- ClientPropertiesTypeDef
- ComputeTypeTypeDef
- ConnectClientAddInTypeDef
- ConnectionAliasAssociationTypeDef
- ConnectionAliasPermissionTypeDef
- TagTypeDef
- CopyWorkspaceImageResultTypeDef
- CreateConnectClientAddInRequestRequestTypeDef
- CreateConnectClientAddInResultTypeDef
- CreateConnectionAliasResultTypeDef
- CreateIpGroupResultTypeDef
- PendingCreateStandbyWorkspacesRequestTypeDef
- CreateUpdatedWorkspaceImageResultTypeDef
- RootStorageTypeDef
- UserStorageTypeDef
- OperatingSystemTypeDef
- DefaultClientBrandingAttributesTypeDef
- DefaultImportClientBrandingAttributesTypeDef
- DefaultWorkspaceCreationPropertiesTypeDef
- DeleteClientBrandingRequestRequestTypeDef
- DeleteConnectClientAddInRequestRequestTypeDef
- DeleteConnectionAliasRequestRequestTypeDef
- DeleteIpGroupRequestRequestTypeDef
- DeleteTagsRequestRequestTypeDef
- DeleteWorkspaceBundleRequestRequestTypeDef
- DeleteWorkspaceImageRequestRequestTypeDef
- DeregisterWorkspaceDirectoryRequestRequestTypeDef
- DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef
- DescribeAccountModificationsRequestRequestTypeDef
- DescribeAccountResultTypeDef
- DescribeClientBrandingRequestRequestTypeDef
- IosClientBrandingAttributesTypeDef
- DescribeClientPropertiesRequestRequestTypeDef
- DescribeConnectClientAddInsRequestRequestTypeDef
- DescribeConnectionAliasPermissionsRequestRequestTypeDef
- DescribeConnectionAliasesRequestRequestTypeDef
- DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef
- DescribeIpGroupsRequestRequestTypeDef
- DescribeTagsRequestRequestTypeDef
- DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef
- DescribeWorkspaceBundlesRequestRequestTypeDef
- DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef
- DescribeWorkspaceDirectoriesRequestRequestTypeDef
- DescribeWorkspaceImagePermissionsRequestRequestTypeDef
- ImagePermissionTypeDef
- DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef
- DescribeWorkspaceImagesRequestRequestTypeDef
- DescribeWorkspaceSnapshotsRequestRequestTypeDef
- SnapshotTypeDef
- DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef
- DescribeWorkspacesConnectionStatusRequestRequestTypeDef
- WorkspaceConnectionStatusTypeDef
- DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef
- DescribeWorkspacesRequestRequestTypeDef
- DisassociateConnectionAliasRequestRequestTypeDef
- DisassociateIpGroupsRequestRequestTypeDef
- FailedWorkspaceChangeRequestTypeDef
- IosImportClientBrandingAttributesTypeDef
- ImportWorkspaceImageResultTypeDef
- ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef
- ListAvailableManagementCidrRangesRequestRequestTypeDef
- ListAvailableManagementCidrRangesResultTypeDef
- MigrateWorkspaceRequestRequestTypeDef
- MigrateWorkspaceResultTypeDef
- ModificationStateTypeDef
- ModifyAccountRequestRequestTypeDef
- SamlPropertiesTypeDef
- SelfservicePermissionsTypeDef
- WorkspaceAccessPropertiesTypeDef
- WorkspaceCreationPropertiesTypeDef
- WorkspacePropertiesTypeDef
- ModifyWorkspaceStateRequestRequestTypeDef
- PaginatorConfigTypeDef
- RebootRequestTypeDef
- RebuildRequestTypeDef
- RelatedWorkspacePropertiesTypeDef
- ResponseMetadataTypeDef
- RestoreWorkspaceRequestRequestTypeDef
- RevokeIpRulesRequestRequestTypeDef
- StartRequestTypeDef
- StopRequestTypeDef
- TerminateRequestTypeDef
- UpdateConnectClientAddInRequestRequestTypeDef
- UpdateResultTypeDef
- UpdateWorkspaceBundleRequestRequestTypeDef
- UpdateWorkspaceImagePermissionRequestRequestTypeDef
- DescribeAccountModificationsResultTypeDef
- AuthorizeIpRulesRequestRequestTypeDef
- UpdateRulesOfIpGroupRequestRequestTypeDef
- WorkspacesIpGroupTypeDef
- ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef
- ClientPropertiesResultTypeDef
- ModifyClientPropertiesRequestRequestTypeDef
- DescribeConnectClientAddInsResultTypeDef
- ConnectionAliasTypeDef
- DescribeConnectionAliasPermissionsResultTypeDef
- UpdateConnectionAliasPermissionRequestRequestTypeDef
- CopyWorkspaceImageRequestRequestTypeDef
- CreateConnectionAliasRequestRequestTypeDef
- CreateIpGroupRequestRequestTypeDef
- CreateTagsRequestRequestTypeDef
- CreateUpdatedWorkspaceImageRequestRequestTypeDef
- CreateWorkspaceImageRequestRequestTypeDef
- DescribeTagsResultTypeDef
- ImportWorkspaceImageRequestRequestTypeDef
- RegisterWorkspaceDirectoryRequestRequestTypeDef
- StandbyWorkspaceTypeDef
- CreateWorkspaceBundleRequestRequestTypeDef
- WorkspaceBundleTypeDef
- CreateWorkspaceImageResultTypeDef
- DescribeClientBrandingResultTypeDef
- ImportClientBrandingResultTypeDef
- DescribeWorkspaceImagePermissionsResultTypeDef
- DescribeWorkspaceSnapshotsResultTypeDef
- DescribeWorkspacesConnectionStatusResultTypeDef
- RebootWorkspacesResultTypeDef
- RebuildWorkspacesResultTypeDef
- StartWorkspacesResultTypeDef
- StopWorkspacesResultTypeDef
- TerminateWorkspacesResultTypeDef
- ImportClientBrandingRequestRequestTypeDef
- ModifySamlPropertiesRequestRequestTypeDef
- ModifySelfservicePermissionsRequestRequestTypeDef
- ModifyWorkspaceAccessPropertiesRequestRequestTypeDef
- WorkspaceDirectoryTypeDef
- ModifyWorkspaceCreationPropertiesRequestRequestTypeDef
- ModifyWorkspacePropertiesRequestRequestTypeDef
- WorkspaceRequestTypeDef
- RebootWorkspacesRequestRequestTypeDef
- RebuildWorkspacesRequestRequestTypeDef
- WorkspaceTypeDef
- StartWorkspacesRequestRequestTypeDef
- StopWorkspacesRequestRequestTypeDef
- TerminateWorkspacesRequestRequestTypeDef
- WorkspaceImageTypeDef
- DescribeIpGroupsResultTypeDef
- DescribeClientPropertiesResultTypeDef
- DescribeConnectionAliasesResultTypeDef
- CreateStandbyWorkspacesRequestRequestTypeDef
- FailedCreateStandbyWorkspacesRequestTypeDef
- CreateWorkspaceBundleResultTypeDef
- DescribeWorkspaceBundlesResultTypeDef
- DescribeWorkspaceDirectoriesResultTypeDef
- CreateWorkspacesRequestRequestTypeDef
- FailedCreateWorkspaceRequestTypeDef
- DescribeWorkspacesResultTypeDef
- DescribeWorkspaceImagesResultTypeDef
- CreateStandbyWorkspacesResultTypeDef
- CreateWorkspacesResultTypeDef