WorkSpacesClient#
Index > WorkSpaces > WorkSpacesClient
Auto-generated documentation for WorkSpaces type annotations stubs module mypy-boto3-workspaces.
WorkSpacesClient#
Type annotations and code completion for boto3.client("workspaces")
.
boto3 documentation
# WorkSpacesClient usage example
from boto3.session import Session
from mypy_boto3_workspaces.client import WorkSpacesClient
def get_workspaces_client() -> WorkSpacesClient:
return Session().client("workspaces")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("workspaces").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("workspaces")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.InvalidParameterValuesException,
client.exceptions.InvalidResourceStateException,
client.exceptions.OperationInProgressException,
client.exceptions.OperationNotSupportedException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceAssociatedException,
client.exceptions.ResourceCreationFailedException,
client.exceptions.ResourceLimitExceededException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceUnavailableException,
client.exceptions.UnsupportedNetworkConfigurationException,
client.exceptions.UnsupportedWorkspaceConfigurationException,
client.exceptions.WorkspacesDefaultRoleNotFoundException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_workspaces.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
associate_connection_alias#
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
Type annotations and code completion for boto3.client("workspaces").associate_connection_alias
method.
boto3 documentation
# associate_connection_alias method definition
def associate_connection_alias(
self,
*,
AliasId: str,
ResourceId: str,
) -> AssociateConnectionAliasResultTypeDef: # (1)
...
# associate_connection_alias method usage example with argument unpacking
kwargs: AssociateConnectionAliasRequestRequestTypeDef = { # (1)
"AliasId": ...,
"ResourceId": ...,
}
parent.associate_connection_alias(**kwargs)
associate_ip_groups#
Associates the specified IP access control group with the specified directory.
Type annotations and code completion for boto3.client("workspaces").associate_ip_groups
method.
boto3 documentation
# associate_ip_groups method definition
def associate_ip_groups(
self,
*,
DirectoryId: str,
GroupIds: Sequence[str],
) -> Dict[str, Any]:
...
# associate_ip_groups method usage example with argument unpacking
kwargs: AssociateIpGroupsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"GroupIds": ...,
}
parent.associate_ip_groups(**kwargs)
authorize_ip_rules#
Adds one or more rules to the specified IP access control group.
Type annotations and code completion for boto3.client("workspaces").authorize_ip_rules
method.
boto3 documentation
# authorize_ip_rules method definition
def authorize_ip_rules(
self,
*,
GroupId: str,
UserRules: Sequence[IpRuleItemTypeDef], # (1)
) -> Dict[str, Any]:
...
# authorize_ip_rules method usage example with argument unpacking
kwargs: AuthorizeIpRulesRequestRequestTypeDef = { # (1)
"GroupId": ...,
"UserRules": ...,
}
parent.authorize_ip_rules(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("workspaces").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("workspaces").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
copy_workspace_image#
Copies the specified image from the specified Region to the current Region.
Type annotations and code completion for boto3.client("workspaces").copy_workspace_image
method.
boto3 documentation
# copy_workspace_image method definition
def copy_workspace_image(
self,
*,
Name: str,
SourceImageId: str,
SourceRegion: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CopyWorkspaceImageResultTypeDef: # (2)
...
# copy_workspace_image method usage example with argument unpacking
kwargs: CopyWorkspaceImageRequestRequestTypeDef = { # (1)
"Name": ...,
"SourceImageId": ...,
"SourceRegion": ...,
}
parent.copy_workspace_image(**kwargs)
create_connect_client_add_in#
Creates a client-add-in for Amazon Connect within a directory.
Type annotations and code completion for boto3.client("workspaces").create_connect_client_add_in
method.
boto3 documentation
# create_connect_client_add_in method definition
def create_connect_client_add_in(
self,
*,
ResourceId: str,
Name: str,
URL: str,
) -> CreateConnectClientAddInResultTypeDef: # (1)
...
# create_connect_client_add_in method usage example with argument unpacking
kwargs: CreateConnectClientAddInRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Name": ...,
"URL": ...,
}
parent.create_connect_client_add_in(**kwargs)
create_connection_alias#
Creates the specified connection alias for use with cross-Region redirection.
Type annotations and code completion for boto3.client("workspaces").create_connection_alias
method.
boto3 documentation
# create_connection_alias method definition
def create_connection_alias(
self,
*,
ConnectionString: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateConnectionAliasResultTypeDef: # (2)
...
# create_connection_alias method usage example with argument unpacking
kwargs: CreateConnectionAliasRequestRequestTypeDef = { # (1)
"ConnectionString": ...,
}
parent.create_connection_alias(**kwargs)
create_ip_group#
Creates an IP access control group.
Type annotations and code completion for boto3.client("workspaces").create_ip_group
method.
boto3 documentation
# create_ip_group method definition
def create_ip_group(
self,
*,
GroupName: str,
GroupDesc: str = ...,
UserRules: Sequence[IpRuleItemTypeDef] = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateIpGroupResultTypeDef: # (3)
...
- See IpRuleItemTypeDef
- See TagTypeDef
- See CreateIpGroupResultTypeDef
# create_ip_group method usage example with argument unpacking
kwargs: CreateIpGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.create_ip_group(**kwargs)
create_standby_workspaces#
Creates a standby WorkSpace in a secondary Region.
Type annotations and code completion for boto3.client("workspaces").create_standby_workspaces
method.
boto3 documentation
# create_standby_workspaces method definition
def create_standby_workspaces(
self,
*,
PrimaryRegion: str,
StandbyWorkspaces: Sequence[StandbyWorkspaceTypeDef], # (1)
) -> CreateStandbyWorkspacesResultTypeDef: # (2)
...
# create_standby_workspaces method usage example with argument unpacking
kwargs: CreateStandbyWorkspacesRequestRequestTypeDef = { # (1)
"PrimaryRegion": ...,
"StandbyWorkspaces": ...,
}
parent.create_standby_workspaces(**kwargs)
create_tags#
Creates the specified tags for the specified WorkSpaces resource.
Type annotations and code completion for boto3.client("workspaces").create_tags
method.
boto3 documentation
# create_tags method definition
def create_tags(
self,
*,
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# create_tags method usage example with argument unpacking
kwargs: CreateTagsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Tags": ...,
}
parent.create_tags(**kwargs)
create_updated_workspace_image#
Creates a new updated WorkSpace image based on the specified source image.
Type annotations and code completion for boto3.client("workspaces").create_updated_workspace_image
method.
boto3 documentation
# create_updated_workspace_image method definition
def create_updated_workspace_image(
self,
*,
Name: str,
Description: str,
SourceImageId: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateUpdatedWorkspaceImageResultTypeDef: # (2)
...
# create_updated_workspace_image method usage example with argument unpacking
kwargs: CreateUpdatedWorkspaceImageRequestRequestTypeDef = { # (1)
"Name": ...,
"Description": ...,
"SourceImageId": ...,
}
parent.create_updated_workspace_image(**kwargs)
create_workspace_bundle#
Creates the specified WorkSpace bundle.
Type annotations and code completion for boto3.client("workspaces").create_workspace_bundle
method.
boto3 documentation
# create_workspace_bundle method definition
def create_workspace_bundle(
self,
*,
BundleName: str,
BundleDescription: str,
ImageId: str,
ComputeType: ComputeTypeTypeDef, # (1)
UserStorage: UserStorageTypeDef, # (2)
RootStorage: RootStorageTypeDef = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateWorkspaceBundleResultTypeDef: # (5)
...
- See ComputeTypeTypeDef
- See UserStorageTypeDef
- See RootStorageTypeDef
- See TagTypeDef
- See CreateWorkspaceBundleResultTypeDef
# create_workspace_bundle method usage example with argument unpacking
kwargs: CreateWorkspaceBundleRequestRequestTypeDef = { # (1)
"BundleName": ...,
"BundleDescription": ...,
"ImageId": ...,
"ComputeType": ...,
"UserStorage": ...,
}
parent.create_workspace_bundle(**kwargs)
create_workspace_image#
Creates a new WorkSpace image from an existing WorkSpace.
Type annotations and code completion for boto3.client("workspaces").create_workspace_image
method.
boto3 documentation
# create_workspace_image method definition
def create_workspace_image(
self,
*,
Name: str,
Description: str,
WorkspaceId: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateWorkspaceImageResultTypeDef: # (2)
...
# create_workspace_image method usage example with argument unpacking
kwargs: CreateWorkspaceImageRequestRequestTypeDef = { # (1)
"Name": ...,
"Description": ...,
"WorkspaceId": ...,
}
parent.create_workspace_image(**kwargs)
create_workspaces#
Creates one or more WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").create_workspaces
method.
boto3 documentation
# create_workspaces method definition
def create_workspaces(
self,
*,
Workspaces: Sequence[WorkspaceRequestTypeDef], # (1)
) -> CreateWorkspacesResultTypeDef: # (2)
...
# create_workspaces method usage example with argument unpacking
kwargs: CreateWorkspacesRequestRequestTypeDef = { # (1)
"Workspaces": ...,
}
parent.create_workspaces(**kwargs)
delete_client_branding#
Deletes customized client branding.
Type annotations and code completion for boto3.client("workspaces").delete_client_branding
method.
boto3 documentation
# delete_client_branding method definition
def delete_client_branding(
self,
*,
ResourceId: str,
Platforms: Sequence[ClientDeviceTypeType], # (1)
) -> Dict[str, Any]:
...
# delete_client_branding method usage example with argument unpacking
kwargs: DeleteClientBrandingRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Platforms": ...,
}
parent.delete_client_branding(**kwargs)
delete_connect_client_add_in#
Deletes a client-add-in for Amazon Connect that is configured within a directory.
Type annotations and code completion for boto3.client("workspaces").delete_connect_client_add_in
method.
boto3 documentation
# delete_connect_client_add_in method definition
def delete_connect_client_add_in(
self,
*,
AddInId: str,
ResourceId: str,
) -> Dict[str, Any]:
...
# delete_connect_client_add_in method usage example with argument unpacking
kwargs: DeleteConnectClientAddInRequestRequestTypeDef = { # (1)
"AddInId": ...,
"ResourceId": ...,
}
parent.delete_connect_client_add_in(**kwargs)
delete_connection_alias#
Deletes the specified connection alias.
Type annotations and code completion for boto3.client("workspaces").delete_connection_alias
method.
boto3 documentation
# delete_connection_alias method definition
def delete_connection_alias(
self,
*,
AliasId: str,
) -> Dict[str, Any]:
...
# delete_connection_alias method usage example with argument unpacking
kwargs: DeleteConnectionAliasRequestRequestTypeDef = { # (1)
"AliasId": ...,
}
parent.delete_connection_alias(**kwargs)
delete_ip_group#
Deletes the specified IP access control group.
Type annotations and code completion for boto3.client("workspaces").delete_ip_group
method.
boto3 documentation
# delete_ip_group method definition
def delete_ip_group(
self,
*,
GroupId: str,
) -> Dict[str, Any]:
...
# delete_ip_group method usage example with argument unpacking
kwargs: DeleteIpGroupRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.delete_ip_group(**kwargs)
delete_tags#
Deletes the specified tags from the specified WorkSpaces resource.
Type annotations and code completion for boto3.client("workspaces").delete_tags
method.
boto3 documentation
# delete_tags method definition
def delete_tags(
self,
*,
ResourceId: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# delete_tags method usage example with argument unpacking
kwargs: DeleteTagsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"TagKeys": ...,
}
parent.delete_tags(**kwargs)
delete_workspace_bundle#
Deletes the specified WorkSpace bundle.
Type annotations and code completion for boto3.client("workspaces").delete_workspace_bundle
method.
boto3 documentation
# delete_workspace_bundle method definition
def delete_workspace_bundle(
self,
*,
BundleId: str = ...,
) -> Dict[str, Any]:
...
# delete_workspace_bundle method usage example with argument unpacking
kwargs: DeleteWorkspaceBundleRequestRequestTypeDef = { # (1)
"BundleId": ...,
}
parent.delete_workspace_bundle(**kwargs)
delete_workspace_image#
Deletes the specified image from your account.
Type annotations and code completion for boto3.client("workspaces").delete_workspace_image
method.
boto3 documentation
# delete_workspace_image method definition
def delete_workspace_image(
self,
*,
ImageId: str,
) -> Dict[str, Any]:
...
# delete_workspace_image method usage example with argument unpacking
kwargs: DeleteWorkspaceImageRequestRequestTypeDef = { # (1)
"ImageId": ...,
}
parent.delete_workspace_image(**kwargs)
deregister_workspace_directory#
Deregisters the specified directory.
Type annotations and code completion for boto3.client("workspaces").deregister_workspace_directory
method.
boto3 documentation
# deregister_workspace_directory method definition
def deregister_workspace_directory(
self,
*,
DirectoryId: str,
) -> Dict[str, Any]:
...
# deregister_workspace_directory method usage example with argument unpacking
kwargs: DeregisterWorkspaceDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.deregister_workspace_directory(**kwargs)
describe_account#
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
Type annotations and code completion for boto3.client("workspaces").describe_account
method.
boto3 documentation
# describe_account method definition
def describe_account(
self,
) -> DescribeAccountResultTypeDef: # (1)
...
describe_account_modifications#
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
Type annotations and code completion for boto3.client("workspaces").describe_account_modifications
method.
boto3 documentation
# describe_account_modifications method definition
def describe_account_modifications(
self,
*,
NextToken: str = ...,
) -> DescribeAccountModificationsResultTypeDef: # (1)
...
# describe_account_modifications method usage example with argument unpacking
kwargs: DescribeAccountModificationsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_account_modifications(**kwargs)
describe_client_branding#
Describes the specified client branding.
Type annotations and code completion for boto3.client("workspaces").describe_client_branding
method.
boto3 documentation
# describe_client_branding method definition
def describe_client_branding(
self,
*,
ResourceId: str,
) -> DescribeClientBrandingResultTypeDef: # (1)
...
# describe_client_branding method usage example with argument unpacking
kwargs: DescribeClientBrandingRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.describe_client_branding(**kwargs)
describe_client_properties#
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
Type annotations and code completion for boto3.client("workspaces").describe_client_properties
method.
boto3 documentation
# describe_client_properties method definition
def describe_client_properties(
self,
*,
ResourceIds: Sequence[str],
) -> DescribeClientPropertiesResultTypeDef: # (1)
...
# describe_client_properties method usage example with argument unpacking
kwargs: DescribeClientPropertiesRequestRequestTypeDef = { # (1)
"ResourceIds": ...,
}
parent.describe_client_properties(**kwargs)
describe_connect_client_add_ins#
Retrieves a list of Amazon Connect client add-ins that have been created.
Type annotations and code completion for boto3.client("workspaces").describe_connect_client_add_ins
method.
boto3 documentation
# describe_connect_client_add_ins method definition
def describe_connect_client_add_ins(
self,
*,
ResourceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeConnectClientAddInsResultTypeDef: # (1)
...
# describe_connect_client_add_ins method usage example with argument unpacking
kwargs: DescribeConnectClientAddInsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.describe_connect_client_add_ins(**kwargs)
describe_connection_alias_permissions#
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.
Type annotations and code completion for boto3.client("workspaces").describe_connection_alias_permissions
method.
boto3 documentation
# describe_connection_alias_permissions method definition
def describe_connection_alias_permissions(
self,
*,
AliasId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeConnectionAliasPermissionsResultTypeDef: # (1)
...
# describe_connection_alias_permissions method usage example with argument unpacking
kwargs: DescribeConnectionAliasPermissionsRequestRequestTypeDef = { # (1)
"AliasId": ...,
}
parent.describe_connection_alias_permissions(**kwargs)
describe_connection_aliases#
Retrieves a list that describes the connection aliases used for cross-Region redirection.
Type annotations and code completion for boto3.client("workspaces").describe_connection_aliases
method.
boto3 documentation
# describe_connection_aliases method definition
def describe_connection_aliases(
self,
*,
AliasIds: Sequence[str] = ...,
ResourceId: str = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConnectionAliasesResultTypeDef: # (1)
...
# describe_connection_aliases method usage example with argument unpacking
kwargs: DescribeConnectionAliasesRequestRequestTypeDef = { # (1)
"AliasIds": ...,
}
parent.describe_connection_aliases(**kwargs)
describe_ip_groups#
Describes one or more of your IP access control groups.
Type annotations and code completion for boto3.client("workspaces").describe_ip_groups
method.
boto3 documentation
# describe_ip_groups method definition
def describe_ip_groups(
self,
*,
GroupIds: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeIpGroupsResultTypeDef: # (1)
...
# describe_ip_groups method usage example with argument unpacking
kwargs: DescribeIpGroupsRequestRequestTypeDef = { # (1)
"GroupIds": ...,
}
parent.describe_ip_groups(**kwargs)
describe_tags#
Describes the specified tags for the specified WorkSpaces resource.
Type annotations and code completion for boto3.client("workspaces").describe_tags
method.
boto3 documentation
# describe_tags method definition
def describe_tags(
self,
*,
ResourceId: str,
) -> DescribeTagsResultTypeDef: # (1)
...
# describe_tags method usage example with argument unpacking
kwargs: DescribeTagsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.describe_tags(**kwargs)
describe_workspace_bundles#
Retrieves a list that describes the available WorkSpace bundles.
Type annotations and code completion for boto3.client("workspaces").describe_workspace_bundles
method.
boto3 documentation
# describe_workspace_bundles method definition
def describe_workspace_bundles(
self,
*,
BundleIds: Sequence[str] = ...,
Owner: str = ...,
NextToken: str = ...,
) -> DescribeWorkspaceBundlesResultTypeDef: # (1)
...
# describe_workspace_bundles method usage example with argument unpacking
kwargs: DescribeWorkspaceBundlesRequestRequestTypeDef = { # (1)
"BundleIds": ...,
}
parent.describe_workspace_bundles(**kwargs)
describe_workspace_directories#
Describes the available directories that are registered with Amazon WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").describe_workspace_directories
method.
boto3 documentation
# describe_workspace_directories method definition
def describe_workspace_directories(
self,
*,
DirectoryIds: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeWorkspaceDirectoriesResultTypeDef: # (1)
...
# describe_workspace_directories method usage example with argument unpacking
kwargs: DescribeWorkspaceDirectoriesRequestRequestTypeDef = { # (1)
"DirectoryIds": ...,
}
parent.describe_workspace_directories(**kwargs)
describe_workspace_image_permissions#
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
Type annotations and code completion for boto3.client("workspaces").describe_workspace_image_permissions
method.
boto3 documentation
# describe_workspace_image_permissions method definition
def describe_workspace_image_permissions(
self,
*,
ImageId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeWorkspaceImagePermissionsResultTypeDef: # (1)
...
# describe_workspace_image_permissions method usage example with argument unpacking
kwargs: DescribeWorkspaceImagePermissionsRequestRequestTypeDef = { # (1)
"ImageId": ...,
}
parent.describe_workspace_image_permissions(**kwargs)
describe_workspace_images#
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
Type annotations and code completion for boto3.client("workspaces").describe_workspace_images
method.
boto3 documentation
# describe_workspace_images method definition
def describe_workspace_images(
self,
*,
ImageIds: Sequence[str] = ...,
ImageType: ImageTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeWorkspaceImagesResultTypeDef: # (2)
...
# describe_workspace_images method usage example with argument unpacking
kwargs: DescribeWorkspaceImagesRequestRequestTypeDef = { # (1)
"ImageIds": ...,
}
parent.describe_workspace_images(**kwargs)
describe_workspace_snapshots#
Describes the snapshots for the specified WorkSpace.
Type annotations and code completion for boto3.client("workspaces").describe_workspace_snapshots
method.
boto3 documentation
# describe_workspace_snapshots method definition
def describe_workspace_snapshots(
self,
*,
WorkspaceId: str,
) -> DescribeWorkspaceSnapshotsResultTypeDef: # (1)
...
# describe_workspace_snapshots method usage example with argument unpacking
kwargs: DescribeWorkspaceSnapshotsRequestRequestTypeDef = { # (1)
"WorkspaceId": ...,
}
parent.describe_workspace_snapshots(**kwargs)
describe_workspaces#
Describes the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").describe_workspaces
method.
boto3 documentation
# describe_workspaces method definition
def describe_workspaces(
self,
*,
WorkspaceIds: Sequence[str] = ...,
DirectoryId: str = ...,
UserName: str = ...,
BundleId: str = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeWorkspacesResultTypeDef: # (1)
...
# describe_workspaces method usage example with argument unpacking
kwargs: DescribeWorkspacesRequestRequestTypeDef = { # (1)
"WorkspaceIds": ...,
}
parent.describe_workspaces(**kwargs)
describe_workspaces_connection_status#
Describes the connection status of the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").describe_workspaces_connection_status
method.
boto3 documentation
# describe_workspaces_connection_status method definition
def describe_workspaces_connection_status(
self,
*,
WorkspaceIds: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeWorkspacesConnectionStatusResultTypeDef: # (1)
...
# describe_workspaces_connection_status method usage example with argument unpacking
kwargs: DescribeWorkspacesConnectionStatusRequestRequestTypeDef = { # (1)
"WorkspaceIds": ...,
}
parent.describe_workspaces_connection_status(**kwargs)
disassociate_connection_alias#
Disassociates a connection alias from a directory.
Type annotations and code completion for boto3.client("workspaces").disassociate_connection_alias
method.
boto3 documentation
# disassociate_connection_alias method definition
def disassociate_connection_alias(
self,
*,
AliasId: str,
) -> Dict[str, Any]:
...
# disassociate_connection_alias method usage example with argument unpacking
kwargs: DisassociateConnectionAliasRequestRequestTypeDef = { # (1)
"AliasId": ...,
}
parent.disassociate_connection_alias(**kwargs)
disassociate_ip_groups#
Disassociates the specified IP access control group from the specified directory.
Type annotations and code completion for boto3.client("workspaces").disassociate_ip_groups
method.
boto3 documentation
# disassociate_ip_groups method definition
def disassociate_ip_groups(
self,
*,
DirectoryId: str,
GroupIds: Sequence[str],
) -> Dict[str, Any]:
...
# disassociate_ip_groups method usage example with argument unpacking
kwargs: DisassociateIpGroupsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"GroupIds": ...,
}
parent.disassociate_ip_groups(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("workspaces").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
import_client_branding#
Imports client branding.
Type annotations and code completion for boto3.client("workspaces").import_client_branding
method.
boto3 documentation
# import_client_branding method definition
def import_client_branding(
self,
*,
ResourceId: str,
DeviceTypeWindows: DefaultImportClientBrandingAttributesTypeDef = ..., # (1)
DeviceTypeOsx: DefaultImportClientBrandingAttributesTypeDef = ..., # (1)
DeviceTypeAndroid: DefaultImportClientBrandingAttributesTypeDef = ..., # (1)
DeviceTypeIos: IosImportClientBrandingAttributesTypeDef = ..., # (4)
DeviceTypeLinux: DefaultImportClientBrandingAttributesTypeDef = ..., # (1)
DeviceTypeWeb: DefaultImportClientBrandingAttributesTypeDef = ..., # (1)
) -> ImportClientBrandingResultTypeDef: # (7)
...
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See IosImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See DefaultImportClientBrandingAttributesTypeDef
- See ImportClientBrandingResultTypeDef
# import_client_branding method usage example with argument unpacking
kwargs: ImportClientBrandingRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.import_client_branding(**kwargs)
import_workspace_image#
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").import_workspace_image
method.
boto3 documentation
# import_workspace_image method definition
def import_workspace_image(
self,
*,
Ec2ImageId: str,
IngestionProcess: WorkspaceImageIngestionProcessType, # (1)
ImageName: str,
ImageDescription: str,
Tags: Sequence[TagTypeDef] = ..., # (2)
Applications: Sequence[ApplicationType] = ..., # (3)
) -> ImportWorkspaceImageResultTypeDef: # (4)
...
- See WorkspaceImageIngestionProcessType
- See TagTypeDef
- See ApplicationType
- See ImportWorkspaceImageResultTypeDef
# import_workspace_image method usage example with argument unpacking
kwargs: ImportWorkspaceImageRequestRequestTypeDef = { # (1)
"Ec2ImageId": ...,
"IngestionProcess": ...,
"ImageName": ...,
"ImageDescription": ...,
}
parent.import_workspace_image(**kwargs)
list_available_management_cidr_ranges#
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
Type annotations and code completion for boto3.client("workspaces").list_available_management_cidr_ranges
method.
boto3 documentation
# list_available_management_cidr_ranges method definition
def list_available_management_cidr_ranges(
self,
*,
ManagementCidrRangeConstraint: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAvailableManagementCidrRangesResultTypeDef: # (1)
...
# list_available_management_cidr_ranges method usage example with argument unpacking
kwargs: ListAvailableManagementCidrRangesRequestRequestTypeDef = { # (1)
"ManagementCidrRangeConstraint": ...,
}
parent.list_available_management_cidr_ranges(**kwargs)
migrate_workspace#
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
Type annotations and code completion for boto3.client("workspaces").migrate_workspace
method.
boto3 documentation
# migrate_workspace method definition
def migrate_workspace(
self,
*,
SourceWorkspaceId: str,
BundleId: str,
) -> MigrateWorkspaceResultTypeDef: # (1)
...
# migrate_workspace method usage example with argument unpacking
kwargs: MigrateWorkspaceRequestRequestTypeDef = { # (1)
"SourceWorkspaceId": ...,
"BundleId": ...,
}
parent.migrate_workspace(**kwargs)
modify_account#
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
Type annotations and code completion for boto3.client("workspaces").modify_account
method.
boto3 documentation
# modify_account method definition
def modify_account(
self,
*,
DedicatedTenancySupport: DedicatedTenancySupportEnumType = ..., # (1)
DedicatedTenancyManagementCidrRange: str = ...,
) -> Dict[str, Any]:
...
# modify_account method usage example with argument unpacking
kwargs: ModifyAccountRequestRequestTypeDef = { # (1)
"DedicatedTenancySupport": ...,
}
parent.modify_account(**kwargs)
modify_certificate_based_auth_properties#
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").modify_certificate_based_auth_properties
method.
boto3 documentation
# modify_certificate_based_auth_properties method definition
def modify_certificate_based_auth_properties(
self,
*,
ResourceId: str,
CertificateBasedAuthProperties: CertificateBasedAuthPropertiesTypeDef = ..., # (1)
PropertiesToDelete: Sequence[DeletableCertificateBasedAuthPropertyType] = ..., # (2)
) -> Dict[str, Any]:
...
# modify_certificate_based_auth_properties method usage example with argument unpacking
kwargs: ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.modify_certificate_based_auth_properties(**kwargs)
modify_client_properties#
Modifies the properties of the specified Amazon WorkSpaces clients.
Type annotations and code completion for boto3.client("workspaces").modify_client_properties
method.
boto3 documentation
# modify_client_properties method definition
def modify_client_properties(
self,
*,
ResourceId: str,
ClientProperties: ClientPropertiesTypeDef, # (1)
) -> Dict[str, Any]:
...
# modify_client_properties method usage example with argument unpacking
kwargs: ModifyClientPropertiesRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"ClientProperties": ...,
}
parent.modify_client_properties(**kwargs)
modify_saml_properties#
Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
Type annotations and code completion for boto3.client("workspaces").modify_saml_properties
method.
boto3 documentation
# modify_saml_properties method definition
def modify_saml_properties(
self,
*,
ResourceId: str,
SamlProperties: SamlPropertiesTypeDef = ..., # (1)
PropertiesToDelete: Sequence[DeletableSamlPropertyType] = ..., # (2)
) -> Dict[str, Any]:
...
# modify_saml_properties method usage example with argument unpacking
kwargs: ModifySamlPropertiesRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.modify_saml_properties(**kwargs)
modify_selfservice_permissions#
Modifies the self-service WorkSpace management capabilities for your users.
Type annotations and code completion for boto3.client("workspaces").modify_selfservice_permissions
method.
boto3 documentation
# modify_selfservice_permissions method definition
def modify_selfservice_permissions(
self,
*,
ResourceId: str,
SelfservicePermissions: SelfservicePermissionsTypeDef, # (1)
) -> Dict[str, Any]:
...
# modify_selfservice_permissions method usage example with argument unpacking
kwargs: ModifySelfservicePermissionsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"SelfservicePermissions": ...,
}
parent.modify_selfservice_permissions(**kwargs)
modify_workspace_access_properties#
Specifies which devices and operating systems users can use to access their WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").modify_workspace_access_properties
method.
boto3 documentation
# modify_workspace_access_properties method definition
def modify_workspace_access_properties(
self,
*,
ResourceId: str,
WorkspaceAccessProperties: WorkspaceAccessPropertiesTypeDef, # (1)
) -> Dict[str, Any]:
...
# modify_workspace_access_properties method usage example with argument unpacking
kwargs: ModifyWorkspaceAccessPropertiesRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"WorkspaceAccessProperties": ...,
}
parent.modify_workspace_access_properties(**kwargs)
modify_workspace_creation_properties#
Modify the default properties used to create WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").modify_workspace_creation_properties
method.
boto3 documentation
# modify_workspace_creation_properties method definition
def modify_workspace_creation_properties(
self,
*,
ResourceId: str,
WorkspaceCreationProperties: WorkspaceCreationPropertiesTypeDef, # (1)
) -> Dict[str, Any]:
...
# modify_workspace_creation_properties method usage example with argument unpacking
kwargs: ModifyWorkspaceCreationPropertiesRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"WorkspaceCreationProperties": ...,
}
parent.modify_workspace_creation_properties(**kwargs)
modify_workspace_properties#
Modifies the specified WorkSpace properties.
Type annotations and code completion for boto3.client("workspaces").modify_workspace_properties
method.
boto3 documentation
# modify_workspace_properties method definition
def modify_workspace_properties(
self,
*,
WorkspaceId: str,
WorkspaceProperties: WorkspacePropertiesTypeDef, # (1)
) -> Dict[str, Any]:
...
# modify_workspace_properties method usage example with argument unpacking
kwargs: ModifyWorkspacePropertiesRequestRequestTypeDef = { # (1)
"WorkspaceId": ...,
"WorkspaceProperties": ...,
}
parent.modify_workspace_properties(**kwargs)
modify_workspace_state#
Sets the state of the specified WorkSpace.
Type annotations and code completion for boto3.client("workspaces").modify_workspace_state
method.
boto3 documentation
# modify_workspace_state method definition
def modify_workspace_state(
self,
*,
WorkspaceId: str,
WorkspaceState: TargetWorkspaceStateType, # (1)
) -> Dict[str, Any]:
...
# modify_workspace_state method usage example with argument unpacking
kwargs: ModifyWorkspaceStateRequestRequestTypeDef = { # (1)
"WorkspaceId": ...,
"WorkspaceState": ...,
}
parent.modify_workspace_state(**kwargs)
reboot_workspaces#
Reboots the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").reboot_workspaces
method.
boto3 documentation
# reboot_workspaces method definition
def reboot_workspaces(
self,
*,
RebootWorkspaceRequests: Sequence[RebootRequestTypeDef], # (1)
) -> RebootWorkspacesResultTypeDef: # (2)
...
# reboot_workspaces method usage example with argument unpacking
kwargs: RebootWorkspacesRequestRequestTypeDef = { # (1)
"RebootWorkspaceRequests": ...,
}
parent.reboot_workspaces(**kwargs)
rebuild_workspaces#
Rebuilds the specified WorkSpace.
Type annotations and code completion for boto3.client("workspaces").rebuild_workspaces
method.
boto3 documentation
# rebuild_workspaces method definition
def rebuild_workspaces(
self,
*,
RebuildWorkspaceRequests: Sequence[RebuildRequestTypeDef], # (1)
) -> RebuildWorkspacesResultTypeDef: # (2)
...
# rebuild_workspaces method usage example with argument unpacking
kwargs: RebuildWorkspacesRequestRequestTypeDef = { # (1)
"RebuildWorkspaceRequests": ...,
}
parent.rebuild_workspaces(**kwargs)
register_workspace_directory#
Registers the specified directory.
Type annotations and code completion for boto3.client("workspaces").register_workspace_directory
method.
boto3 documentation
# register_workspace_directory method definition
def register_workspace_directory(
self,
*,
DirectoryId: str,
EnableWorkDocs: bool,
SubnetIds: Sequence[str] = ...,
EnableSelfService: bool = ...,
Tenancy: TenancyType = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
- See TenancyType
- See TagTypeDef
# register_workspace_directory method usage example with argument unpacking
kwargs: RegisterWorkspaceDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"EnableWorkDocs": ...,
}
parent.register_workspace_directory(**kwargs)
restore_workspace#
Restores the specified WorkSpace to its last known healthy state.
Type annotations and code completion for boto3.client("workspaces").restore_workspace
method.
boto3 documentation
# restore_workspace method definition
def restore_workspace(
self,
*,
WorkspaceId: str,
) -> Dict[str, Any]:
...
# restore_workspace method usage example with argument unpacking
kwargs: RestoreWorkspaceRequestRequestTypeDef = { # (1)
"WorkspaceId": ...,
}
parent.restore_workspace(**kwargs)
revoke_ip_rules#
Removes one or more rules from the specified IP access control group.
Type annotations and code completion for boto3.client("workspaces").revoke_ip_rules
method.
boto3 documentation
# revoke_ip_rules method definition
def revoke_ip_rules(
self,
*,
GroupId: str,
UserRules: Sequence[str],
) -> Dict[str, Any]:
...
# revoke_ip_rules method usage example with argument unpacking
kwargs: RevokeIpRulesRequestRequestTypeDef = { # (1)
"GroupId": ...,
"UserRules": ...,
}
parent.revoke_ip_rules(**kwargs)
start_workspaces#
Starts the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").start_workspaces
method.
boto3 documentation
# start_workspaces method definition
def start_workspaces(
self,
*,
StartWorkspaceRequests: Sequence[StartRequestTypeDef], # (1)
) -> StartWorkspacesResultTypeDef: # (2)
...
# start_workspaces method usage example with argument unpacking
kwargs: StartWorkspacesRequestRequestTypeDef = { # (1)
"StartWorkspaceRequests": ...,
}
parent.start_workspaces(**kwargs)
stop_workspaces#
Stops the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").stop_workspaces
method.
boto3 documentation
# stop_workspaces method definition
def stop_workspaces(
self,
*,
StopWorkspaceRequests: Sequence[StopRequestTypeDef], # (1)
) -> StopWorkspacesResultTypeDef: # (2)
...
# stop_workspaces method usage example with argument unpacking
kwargs: StopWorkspacesRequestRequestTypeDef = { # (1)
"StopWorkspaceRequests": ...,
}
parent.stop_workspaces(**kwargs)
terminate_workspaces#
Terminates the specified WorkSpaces.
Type annotations and code completion for boto3.client("workspaces").terminate_workspaces
method.
boto3 documentation
# terminate_workspaces method definition
def terminate_workspaces(
self,
*,
TerminateWorkspaceRequests: Sequence[TerminateRequestTypeDef], # (1)
) -> TerminateWorkspacesResultTypeDef: # (2)
...
# terminate_workspaces method usage example with argument unpacking
kwargs: TerminateWorkspacesRequestRequestTypeDef = { # (1)
"TerminateWorkspaceRequests": ...,
}
parent.terminate_workspaces(**kwargs)
update_connect_client_add_in#
Updates a Amazon Connect client add-in.
Type annotations and code completion for boto3.client("workspaces").update_connect_client_add_in
method.
boto3 documentation
# update_connect_client_add_in method definition
def update_connect_client_add_in(
self,
*,
AddInId: str,
ResourceId: str,
Name: str = ...,
URL: str = ...,
) -> Dict[str, Any]:
...
# update_connect_client_add_in method usage example with argument unpacking
kwargs: UpdateConnectClientAddInRequestRequestTypeDef = { # (1)
"AddInId": ...,
"ResourceId": ...,
}
parent.update_connect_client_add_in(**kwargs)
update_connection_alias_permission#
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.
Type annotations and code completion for boto3.client("workspaces").update_connection_alias_permission
method.
boto3 documentation
# update_connection_alias_permission method definition
def update_connection_alias_permission(
self,
*,
AliasId: str,
ConnectionAliasPermission: ConnectionAliasPermissionTypeDef, # (1)
) -> Dict[str, Any]:
...
# update_connection_alias_permission method usage example with argument unpacking
kwargs: UpdateConnectionAliasPermissionRequestRequestTypeDef = { # (1)
"AliasId": ...,
"ConnectionAliasPermission": ...,
}
parent.update_connection_alias_permission(**kwargs)
update_rules_of_ip_group#
Replaces the current rules of the specified IP access control group with the specified rules.
Type annotations and code completion for boto3.client("workspaces").update_rules_of_ip_group
method.