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 schema.
# AccessPropertyValueType usage example
from mypy_boto3_workspaces.literals import AccessPropertyValueType
def get_value() -> AccessPropertyValueType:
return "ALLOW"
- AccessPropertyValueType
- ApplicationAssociatedResourceTypeType
- ApplicationType
- AssociationErrorCodeType
- AssociationStateType
- AssociationStatusType
- BundleAssociatedResourceTypeType
- BundleTypeType
- CertificateBasedAuthStatusEnumType
- ClientDeviceTypeType
- ComputeType
- ConnectionAliasStateType
- ConnectionStateType
- DataReplicationType
- DedicatedTenancyModificationStateEnumType
- DedicatedTenancySupportEnumType
- DedicatedTenancySupportResultEnumType
- DeletableCertificateBasedAuthPropertyType
- DeletableSamlPropertyType
- DescribeAccountModificationsPaginatorName
- DescribeIpGroupsPaginatorName
- DescribeWorkspaceBundlesPaginatorName
- DescribeWorkspaceDirectoriesPaginatorName
- DescribeWorkspaceImagesPaginatorName
- DescribeWorkspacesConnectionStatusPaginatorName
- DescribeWorkspacesPaginatorName
- ImageAssociatedResourceTypeType
- ImageTypeType
- ListAvailableManagementCidrRangesPaginatorName
- LogUploadEnumType
- ModificationResourceEnumType
- ModificationStateEnumType
- OperatingSystemNameType
- OperatingSystemTypeType
- ProtocolType
- ReconnectEnumType
- RunningModeType
- SamlStatusEnumType
- StandbyWorkspaceRelationshipTypeType
- TargetWorkspaceStateType
- TenancyType
- WorkSpaceApplicationLicenseTypeType
- WorkSpaceApplicationStateType
- WorkSpaceAssociatedResourceTypeType
- WorkspaceBundleStateType
- WorkspaceDirectoryStateType
- WorkspaceDirectoryTypeType
- WorkspaceImageErrorDetailCodeType
- WorkspaceImageIngestionProcessType
- WorkspaceImageRequiredTenancyType
- WorkspaceImageStateType
- WorkspaceStateType
- WorkSpacesServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountModificationTypeDef
- AssociationStateReasonTypeDef
- AssociateConnectionAliasRequestRequestTypeDef
- ResponseMetadataTypeDef
- AssociateIpGroupsRequestRequestTypeDef
- AssociateWorkspaceApplicationRequestRequestTypeDef
- IpRuleItemTypeDef
- BlobTypeDef
- CertificateBasedAuthPropertiesTypeDef
- ClientPropertiesTypeDef
- ComputeTypeTypeDef
- ConnectClientAddInTypeDef
- ConnectionAliasAssociationTypeDef
- ConnectionAliasPermissionTypeDef
- TagTypeDef
- CreateConnectClientAddInRequestRequestTypeDef
- PendingCreateStandbyWorkspacesRequestTypeDef
- RootStorageTypeDef
- UserStorageTypeDef
- OperatingSystemTypeDef
- DataReplicationSettingsTypeDef
- DefaultClientBrandingAttributesTypeDef
- DefaultWorkspaceCreationPropertiesTypeDef
- DeleteClientBrandingRequestRequestTypeDef
- DeleteConnectClientAddInRequestRequestTypeDef
- DeleteConnectionAliasRequestRequestTypeDef
- DeleteIpGroupRequestRequestTypeDef
- DeleteTagsRequestRequestTypeDef
- DeleteWorkspaceBundleRequestRequestTypeDef
- DeleteWorkspaceImageRequestRequestTypeDef
- DeployWorkspaceApplicationsRequestRequestTypeDef
- DeregisterWorkspaceDirectoryRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeAccountModificationsRequestRequestTypeDef
- DescribeApplicationAssociationsRequestRequestTypeDef
- DescribeApplicationsRequestRequestTypeDef
- WorkSpaceApplicationTypeDef
- DescribeBundleAssociationsRequestRequestTypeDef
- DescribeClientBrandingRequestRequestTypeDef
- IosClientBrandingAttributesTypeDef
- DescribeClientPropertiesRequestRequestTypeDef
- DescribeConnectClientAddInsRequestRequestTypeDef
- DescribeConnectionAliasPermissionsRequestRequestTypeDef
- DescribeConnectionAliasesRequestRequestTypeDef
- DescribeImageAssociationsRequestRequestTypeDef
- DescribeIpGroupsRequestRequestTypeDef
- DescribeTagsRequestRequestTypeDef
- DescribeWorkspaceAssociationsRequestRequestTypeDef
- DescribeWorkspaceBundlesRequestRequestTypeDef
- DescribeWorkspaceDirectoriesRequestRequestTypeDef
- DescribeWorkspaceImagePermissionsRequestRequestTypeDef
- ImagePermissionTypeDef
- DescribeWorkspaceImagesRequestRequestTypeDef
- DescribeWorkspaceSnapshotsRequestRequestTypeDef
- SnapshotTypeDef
- DescribeWorkspacesConnectionStatusRequestRequestTypeDef
- WorkspaceConnectionStatusTypeDef
- DescribeWorkspacesRequestRequestTypeDef
- DisassociateConnectionAliasRequestRequestTypeDef
- DisassociateIpGroupsRequestRequestTypeDef
- DisassociateWorkspaceApplicationRequestRequestTypeDef
- ErrorDetailsTypeDef
- FailedWorkspaceChangeRequestTypeDef
- ListAvailableManagementCidrRangesRequestRequestTypeDef
- MigrateWorkspaceRequestRequestTypeDef
- ModificationStateTypeDef
- ModifyAccountRequestRequestTypeDef
- SamlPropertiesTypeDef
- SelfservicePermissionsTypeDef
- WorkspaceAccessPropertiesTypeDef
- WorkspaceCreationPropertiesTypeDef
- WorkspacePropertiesTypeDef
- ModifyWorkspaceStateRequestRequestTypeDef
- RebootRequestTypeDef
- RebuildRequestTypeDef
- RelatedWorkspacePropertiesTypeDef
- RestoreWorkspaceRequestRequestTypeDef
- RevokeIpRulesRequestRequestTypeDef
- StandbyWorkspacesPropertiesTypeDef
- StartRequestTypeDef
- StopRequestTypeDef
- TerminateRequestTypeDef
- UpdateConnectClientAddInRequestRequestTypeDef
- UpdateResultTypeDef
- UpdateWorkspaceBundleRequestRequestTypeDef
- UpdateWorkspaceImagePermissionRequestRequestTypeDef
- WorkspacePropertiesPaginatorTypeDef
- ApplicationResourceAssociationTypeDef
- BundleResourceAssociationTypeDef
- ImageResourceAssociationTypeDef
- WorkspaceResourceAssociationTypeDef
- AssociateConnectionAliasResultTypeDef
- CopyWorkspaceImageResultTypeDef
- CreateConnectClientAddInResultTypeDef
- CreateConnectionAliasResultTypeDef
- CreateIpGroupResultTypeDef
- CreateUpdatedWorkspaceImageResultTypeDef
- DescribeAccountModificationsResultTypeDef
- DescribeAccountResultTypeDef
- ImportWorkspaceImageResultTypeDef
- ListAvailableManagementCidrRangesResultTypeDef
- MigrateWorkspaceResultTypeDef
- AuthorizeIpRulesRequestRequestTypeDef
- UpdateRulesOfIpGroupRequestRequestTypeDef
- WorkspacesIpGroupTypeDef
- DefaultImportClientBrandingAttributesTypeDef
- IosImportClientBrandingAttributesTypeDef
- ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef
- ClientPropertiesResultTypeDef
- ModifyClientPropertiesRequestRequestTypeDef
- DescribeConnectClientAddInsResultTypeDef
- ConnectionAliasTypeDef
- DescribeConnectionAliasPermissionsResultTypeDef
- UpdateConnectionAliasPermissionRequestRequestTypeDef
- CopyWorkspaceImageRequestRequestTypeDef
- CreateConnectionAliasRequestRequestTypeDef
- CreateIpGroupRequestRequestTypeDef
- CreateTagsRequestRequestTypeDef
- CreateUpdatedWorkspaceImageRequestRequestTypeDef
- CreateWorkspaceImageRequestRequestTypeDef
- DescribeTagsResultTypeDef
- ImportWorkspaceImageRequestRequestTypeDef
- RegisterWorkspaceDirectoryRequestRequestTypeDef
- StandbyWorkspaceTypeDef
- CreateWorkspaceBundleRequestRequestTypeDef
- WorkspaceBundleTypeDef
- CreateWorkspaceImageResultTypeDef
- DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef
- DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef
- DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef
- DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef
- DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef
- DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef
- DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef
- ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef
- DescribeApplicationsResultTypeDef
- DescribeClientBrandingResultTypeDef
- ImportClientBrandingResultTypeDef
- DescribeWorkspaceImagePermissionsResultTypeDef
- DescribeWorkspaceSnapshotsResultTypeDef
- DescribeWorkspacesConnectionStatusResultTypeDef
- RebootWorkspacesResultTypeDef
- RebuildWorkspacesResultTypeDef
- StartWorkspacesResultTypeDef
- StopWorkspacesResultTypeDef
- TerminateWorkspacesResultTypeDef
- ModifySamlPropertiesRequestRequestTypeDef
- ModifySelfservicePermissionsRequestRequestTypeDef
- ModifyWorkspaceAccessPropertiesRequestRequestTypeDef
- WorkspaceDirectoryTypeDef
- ModifyWorkspaceCreationPropertiesRequestRequestTypeDef
- ModifyWorkspacePropertiesRequestRequestTypeDef
- WorkspaceRequestTypeDef
- RebootWorkspacesRequestRequestTypeDef
- RebuildWorkspacesRequestRequestTypeDef
- WorkspaceTypeDef
- StartWorkspacesRequestRequestTypeDef
- StopWorkspacesRequestRequestTypeDef
- TerminateWorkspacesRequestRequestTypeDef
- WorkspaceImageTypeDef
- WorkspacePaginatorTypeDef
- DescribeApplicationAssociationsResultTypeDef
- DescribeBundleAssociationsResultTypeDef
- DescribeImageAssociationsResultTypeDef
- AssociateWorkspaceApplicationResultTypeDef
- DescribeWorkspaceAssociationsResultTypeDef
- DisassociateWorkspaceApplicationResultTypeDef
- WorkSpaceApplicationDeploymentTypeDef
- DescribeIpGroupsResultTypeDef
- ImportClientBrandingRequestRequestTypeDef
- DescribeClientPropertiesResultTypeDef
- DescribeConnectionAliasesResultTypeDef
- CreateStandbyWorkspacesRequestRequestTypeDef
- FailedCreateStandbyWorkspacesRequestTypeDef
- CreateWorkspaceBundleResultTypeDef
- DescribeWorkspaceBundlesResultTypeDef
- DescribeWorkspaceDirectoriesResultTypeDef
- CreateWorkspacesRequestRequestTypeDef
- FailedCreateWorkspaceRequestTypeDef
- DescribeWorkspacesResultTypeDef
- DescribeWorkspaceImagesResultTypeDef
- DescribeWorkspacesResultPaginatorTypeDef
- DeployWorkspaceApplicationsResultTypeDef
- CreateStandbyWorkspacesResultTypeDef
- CreateWorkspacesResultTypeDef