Skip to content

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.ApplicationNotSupportedException,
    client.exceptions.ClientError,
    client.exceptions.ComputeNotCompatibleException,
    client.exceptions.ConflictException,
    client.exceptions.IncompatibleApplicationsException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterValuesException,
    client.exceptions.InvalidResourceStateException,
    client.exceptions.OperatingSystemNotCompatibleException,
    client.exceptions.OperationInProgressException,
    client.exceptions.OperationNotSupportedException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceAssociatedException,
    client.exceptions.ResourceCreationFailedException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceUnavailableException,
    client.exceptions.UnsupportedNetworkConfigurationException,
    client.exceptions.UnsupportedWorkspaceConfigurationException,
    client.exceptions.ValidationException,
    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#

can_paginate#

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:
    ...

generate_presigned_url#

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:
    ...

Accepts the account link invitation.

Type annotations and code completion for boto3.client("workspaces").accept_account_link_invitation method. boto3 documentation

# accept_account_link_invitation method definition

def accept_account_link_invitation(
    self,
    *,
    LinkId: str,
    ClientToken: str = ...,
) -> AcceptAccountLinkInvitationResultTypeDef:  # (1)
    ...
  1. See AcceptAccountLinkInvitationResultTypeDef 
# accept_account_link_invitation method usage example with argument unpacking

kwargs: AcceptAccountLinkInvitationRequestRequestTypeDef = {  # (1)
    "LinkId": ...,
}

parent.accept_account_link_invitation(**kwargs)
  1. See AcceptAccountLinkInvitationRequestRequestTypeDef

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)
    ...
  1. See AssociateConnectionAliasResultTypeDef 
# associate_connection_alias method usage example with argument unpacking

kwargs: AssociateConnectionAliasRequestRequestTypeDef = {  # (1)
    "AliasId": ...,
    "ResourceId": ...,
}

parent.associate_connection_alias(**kwargs)
  1. See AssociateConnectionAliasRequestRequestTypeDef

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)
  1. See AssociateIpGroupsRequestRequestTypeDef

associate_workspace_application#

Associates the specified application to the specified WorkSpace.

Type annotations and code completion for boto3.client("workspaces").associate_workspace_application method. boto3 documentation

# associate_workspace_application method definition

def associate_workspace_application(
    self,
    *,
    WorkspaceId: str,
    ApplicationId: str,
) -> AssociateWorkspaceApplicationResultTypeDef:  # (1)
    ...
  1. See AssociateWorkspaceApplicationResultTypeDef 
# associate_workspace_application method usage example with argument unpacking

kwargs: AssociateWorkspaceApplicationRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
    "ApplicationId": ...,
}

parent.associate_workspace_application(**kwargs)
  1. See AssociateWorkspaceApplicationRequestRequestTypeDef

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]:
    ...
  1. See IpRuleItemTypeDef 
# authorize_ip_rules method usage example with argument unpacking

kwargs: AuthorizeIpRulesRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
    "UserRules": ...,
}

parent.authorize_ip_rules(**kwargs)
  1. See AuthorizeIpRulesRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CopyWorkspaceImageResultTypeDef 
# copy_workspace_image method usage example with argument unpacking

kwargs: CopyWorkspaceImageRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SourceImageId": ...,
    "SourceRegion": ...,
}

parent.copy_workspace_image(**kwargs)
  1. See CopyWorkspaceImageRequestRequestTypeDef

Creates the account link invitation.

Type annotations and code completion for boto3.client("workspaces").create_account_link_invitation method. boto3 documentation

# create_account_link_invitation method definition

def create_account_link_invitation(
    self,
    *,
    TargetAccountId: str,
    ClientToken: str = ...,
) -> CreateAccountLinkInvitationResultTypeDef:  # (1)
    ...
  1. See CreateAccountLinkInvitationResultTypeDef 
# create_account_link_invitation method usage example with argument unpacking

kwargs: CreateAccountLinkInvitationRequestRequestTypeDef = {  # (1)
    "TargetAccountId": ...,
}

parent.create_account_link_invitation(**kwargs)
  1. See CreateAccountLinkInvitationRequestRequestTypeDef

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)
    ...
  1. See CreateConnectClientAddInResultTypeDef 
# create_connect_client_add_in method usage example with argument unpacking

kwargs: CreateConnectClientAddInRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Name": ...,
    "URL": ...,
}

parent.create_connect_client_add_in(**kwargs)
  1. See CreateConnectClientAddInRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateConnectionAliasResultTypeDef 
# create_connection_alias method usage example with argument unpacking

kwargs: CreateConnectionAliasRequestRequestTypeDef = {  # (1)
    "ConnectionString": ...,
}

parent.create_connection_alias(**kwargs)
  1. See CreateConnectionAliasRequestRequestTypeDef

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)
    ...
  1. See IpRuleItemTypeDef
  2. See TagTypeDef
  3. See CreateIpGroupResultTypeDef 
# create_ip_group method usage example with argument unpacking

kwargs: CreateIpGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
}

parent.create_ip_group(**kwargs)
  1. See CreateIpGroupRequestRequestTypeDef

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[StandbyWorkspaceUnionTypeDef],  # (1)
) -> CreateStandbyWorkspacesResultTypeDef:  # (2)
    ...
  1. See StandbyWorkspaceTypeDef StandbyWorkspaceOutputTypeDef
  2. See CreateStandbyWorkspacesResultTypeDef 
# create_standby_workspaces method usage example with argument unpacking

kwargs: CreateStandbyWorkspacesRequestRequestTypeDef = {  # (1)
    "PrimaryRegion": ...,
    "StandbyWorkspaces": ...,
}

parent.create_standby_workspaces(**kwargs)
  1. See CreateStandbyWorkspacesRequestRequestTypeDef

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]:
    ...
  1. See TagTypeDef 
# create_tags method usage example with argument unpacking

kwargs: CreateTagsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Tags": ...,
}

parent.create_tags(**kwargs)
  1. See CreateTagsRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateUpdatedWorkspaceImageResultTypeDef 
# create_updated_workspace_image method usage example with argument unpacking

kwargs: CreateUpdatedWorkspaceImageRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Description": ...,
    "SourceImageId": ...,
}

parent.create_updated_workspace_image(**kwargs)
  1. See CreateUpdatedWorkspaceImageRequestRequestTypeDef

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)
    ...
  1. See ComputeTypeTypeDef
  2. See UserStorageTypeDef
  3. See RootStorageTypeDef
  4. See TagTypeDef
  5. See CreateWorkspaceBundleResultTypeDef 
# create_workspace_bundle method usage example with argument unpacking

kwargs: CreateWorkspaceBundleRequestRequestTypeDef = {  # (1)
    "BundleName": ...,
    "BundleDescription": ...,
    "ImageId": ...,
    "ComputeType": ...,
    "UserStorage": ...,
}

parent.create_workspace_bundle(**kwargs)
  1. See CreateWorkspaceBundleRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateWorkspaceImageResultTypeDef 
# create_workspace_image method usage example with argument unpacking

kwargs: CreateWorkspaceImageRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Description": ...,
    "WorkspaceId": ...,
}

parent.create_workspace_image(**kwargs)
  1. See CreateWorkspaceImageRequestRequestTypeDef

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[WorkspaceRequestUnionTypeDef],  # (1)
) -> CreateWorkspacesResultTypeDef:  # (2)
    ...
  1. See WorkspaceRequestTypeDef WorkspaceRequestOutputTypeDef
  2. See CreateWorkspacesResultTypeDef 
# create_workspaces method usage example with argument unpacking

kwargs: CreateWorkspacesRequestRequestTypeDef = {  # (1)
    "Workspaces": ...,
}

parent.create_workspaces(**kwargs)
  1. See CreateWorkspacesRequestRequestTypeDef

create_workspaces_pool#

Creates a pool of WorkSpaces.

Type annotations and code completion for boto3.client("workspaces").create_workspaces_pool method. boto3 documentation

# create_workspaces_pool method definition

def create_workspaces_pool(
    self,
    *,
    PoolName: str,
    Description: str,
    BundleId: str,
    DirectoryId: str,
    Capacity: CapacityTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ApplicationSettings: ApplicationSettingsRequestTypeDef = ...,  # (3)
    TimeoutSettings: TimeoutSettingsTypeDef = ...,  # (4)
) -> CreateWorkspacesPoolResultTypeDef:  # (5)
    ...
  1. See CapacityTypeDef
  2. See TagTypeDef
  3. See ApplicationSettingsRequestTypeDef
  4. See TimeoutSettingsTypeDef
  5. See CreateWorkspacesPoolResultTypeDef 
# create_workspaces_pool method usage example with argument unpacking

kwargs: CreateWorkspacesPoolRequestRequestTypeDef = {  # (1)
    "PoolName": ...,
    "Description": ...,
    "BundleId": ...,
    "DirectoryId": ...,
    "Capacity": ...,
}

parent.create_workspaces_pool(**kwargs)
  1. See CreateWorkspacesPoolRequestRequestTypeDef

Deletes the account link invitation.

Type annotations and code completion for boto3.client("workspaces").delete_account_link_invitation method. boto3 documentation

# delete_account_link_invitation method definition

def delete_account_link_invitation(
    self,
    *,
    LinkId: str,
    ClientToken: str = ...,
) -> DeleteAccountLinkInvitationResultTypeDef:  # (1)
    ...
  1. See DeleteAccountLinkInvitationResultTypeDef 
# delete_account_link_invitation method usage example with argument unpacking

kwargs: DeleteAccountLinkInvitationRequestRequestTypeDef = {  # (1)
    "LinkId": ...,
}

parent.delete_account_link_invitation(**kwargs)
  1. See DeleteAccountLinkInvitationRequestRequestTypeDef

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]:
    ...
  1. See ClientDeviceTypeType 
# delete_client_branding method usage example with argument unpacking

kwargs: DeleteClientBrandingRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Platforms": ...,
}

parent.delete_client_branding(**kwargs)
  1. See DeleteClientBrandingRequestRequestTypeDef

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)
  1. See DeleteConnectClientAddInRequestRequestTypeDef

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)
  1. See DeleteConnectionAliasRequestRequestTypeDef

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)
  1. See DeleteIpGroupRequestRequestTypeDef

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)
  1. See DeleteTagsRequestRequestTypeDef

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)
  1. See DeleteWorkspaceBundleRequestRequestTypeDef

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)
  1. See DeleteWorkspaceImageRequestRequestTypeDef

deploy_workspace_applications#

Deploys associated applications to the specified WorkSpace.

Type annotations and code completion for boto3.client("workspaces").deploy_workspace_applications method. boto3 documentation

# deploy_workspace_applications method definition

def deploy_workspace_applications(
    self,
    *,
    WorkspaceId: str,
    Force: bool = ...,
) -> DeployWorkspaceApplicationsResultTypeDef:  # (1)
    ...
  1. See DeployWorkspaceApplicationsResultTypeDef 
# deploy_workspace_applications method usage example with argument unpacking

kwargs: DeployWorkspaceApplicationsRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
}

parent.deploy_workspace_applications(**kwargs)
  1. See DeployWorkspaceApplicationsRequestRequestTypeDef

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)
  1. See DeregisterWorkspaceDirectoryRequestRequestTypeDef

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)
    ...
  1. See DescribeAccountResultTypeDef

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)
    ...
  1. See DescribeAccountModificationsResultTypeDef 
# describe_account_modifications method usage example with argument unpacking

kwargs: DescribeAccountModificationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_account_modifications(**kwargs)
  1. See DescribeAccountModificationsRequestRequestTypeDef

describe_application_associations#

Describes the associations between the application and the specified associated resources.

Type annotations and code completion for boto3.client("workspaces").describe_application_associations method. boto3 documentation

# describe_application_associations method definition

def describe_application_associations(
    self,
    *,
    ApplicationId: str,
    AssociatedResourceTypes: Sequence[ApplicationAssociatedResourceTypeType],  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeApplicationAssociationsResultTypeDef:  # (2)
    ...
  1. See ApplicationAssociatedResourceTypeType
  2. See DescribeApplicationAssociationsResultTypeDef 
# describe_application_associations method usage example with argument unpacking

kwargs: DescribeApplicationAssociationsRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "AssociatedResourceTypes": ...,
}

parent.describe_application_associations(**kwargs)
  1. See DescribeApplicationAssociationsRequestRequestTypeDef

describe_applications#

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Type annotations and code completion for boto3.client("workspaces").describe_applications method. boto3 documentation

# describe_applications method definition

def describe_applications(
    self,
    *,
    ApplicationIds: Sequence[str] = ...,
    ComputeTypeNames: Sequence[ComputeType] = ...,  # (1)
    LicenseType: WorkSpaceApplicationLicenseTypeType = ...,  # (2)
    OperatingSystemNames: Sequence[OperatingSystemNameType] = ...,  # (3)
    Owner: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeApplicationsResultTypeDef:  # (4)
    ...
  1. See ComputeType
  2. See WorkSpaceApplicationLicenseTypeType
  3. See OperatingSystemNameType
  4. See DescribeApplicationsResultTypeDef 
# describe_applications method usage example with argument unpacking

kwargs: DescribeApplicationsRequestRequestTypeDef = {  # (1)
    "ApplicationIds": ...,
}

parent.describe_applications(**kwargs)
  1. See DescribeApplicationsRequestRequestTypeDef

describe_bundle_associations#

Describes the associations between the applications and the specified bundle.

Type annotations and code completion for boto3.client("workspaces").describe_bundle_associations method. boto3 documentation

# describe_bundle_associations method definition

def describe_bundle_associations(
    self,
    *,
    BundleId: str,
    AssociatedResourceTypes: Sequence[BundleAssociatedResourceTypeType],  # (1)
) -> DescribeBundleAssociationsResultTypeDef:  # (2)
    ...
  1. See BundleAssociatedResourceTypeType
  2. See DescribeBundleAssociationsResultTypeDef 
# describe_bundle_associations method usage example with argument unpacking

kwargs: DescribeBundleAssociationsRequestRequestTypeDef = {  # (1)
    "BundleId": ...,
    "AssociatedResourceTypes": ...,
}

parent.describe_bundle_associations(**kwargs)
  1. See DescribeBundleAssociationsRequestRequestTypeDef

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)
    ...
  1. See DescribeClientBrandingResultTypeDef 
# describe_client_branding method usage example with argument unpacking

kwargs: DescribeClientBrandingRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.describe_client_branding(**kwargs)
  1. See DescribeClientBrandingRequestRequestTypeDef

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)
    ...
  1. See DescribeClientPropertiesResultTypeDef 
# describe_client_properties method usage example with argument unpacking

kwargs: DescribeClientPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceIds": ...,
}

parent.describe_client_properties(**kwargs)
  1. See DescribeClientPropertiesRequestRequestTypeDef

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)
    ...
  1. See DescribeConnectClientAddInsResultTypeDef 
# describe_connect_client_add_ins method usage example with argument unpacking

kwargs: DescribeConnectClientAddInsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.describe_connect_client_add_ins(**kwargs)
  1. See DescribeConnectClientAddInsRequestRequestTypeDef

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)
    ...
  1. See DescribeConnectionAliasPermissionsResultTypeDef 
# describe_connection_alias_permissions method usage example with argument unpacking

kwargs: DescribeConnectionAliasPermissionsRequestRequestTypeDef = {  # (1)
    "AliasId": ...,
}

parent.describe_connection_alias_permissions(**kwargs)
  1. See DescribeConnectionAliasPermissionsRequestRequestTypeDef

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)
    ...
  1. See DescribeConnectionAliasesResultTypeDef 
# describe_connection_aliases method usage example with argument unpacking

kwargs: DescribeConnectionAliasesRequestRequestTypeDef = {  # (1)
    "AliasIds": ...,
}

parent.describe_connection_aliases(**kwargs)
  1. See DescribeConnectionAliasesRequestRequestTypeDef

describe_image_associations#

Describes the associations between the applications and the specified image.

Type annotations and code completion for boto3.client("workspaces").describe_image_associations method. boto3 documentation

# describe_image_associations method definition

def describe_image_associations(
    self,
    *,
    ImageId: str,
    AssociatedResourceTypes: Sequence[ImageAssociatedResourceTypeType],  # (1)
) -> DescribeImageAssociationsResultTypeDef:  # (2)
    ...
  1. See ImageAssociatedResourceTypeType
  2. See DescribeImageAssociationsResultTypeDef 
# describe_image_associations method usage example with argument unpacking

kwargs: DescribeImageAssociationsRequestRequestTypeDef = {  # (1)
    "ImageId": ...,
    "AssociatedResourceTypes": ...,
}

parent.describe_image_associations(**kwargs)
  1. See DescribeImageAssociationsRequestRequestTypeDef

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)
    ...
  1. See DescribeIpGroupsResultTypeDef 
# describe_ip_groups method usage example with argument unpacking

kwargs: DescribeIpGroupsRequestRequestTypeDef = {  # (1)
    "GroupIds": ...,
}

parent.describe_ip_groups(**kwargs)
  1. See DescribeIpGroupsRequestRequestTypeDef

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)
    ...
  1. See DescribeTagsResultTypeDef 
# describe_tags method usage example with argument unpacking

kwargs: DescribeTagsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.describe_tags(**kwargs)
  1. See DescribeTagsRequestRequestTypeDef

describe_workspace_associations#

Describes the associations betweens applications and the specified WorkSpace.

Type annotations and code completion for boto3.client("workspaces").describe_workspace_associations method. boto3 documentation

# describe_workspace_associations method definition

def describe_workspace_associations(
    self,
    *,
    WorkspaceId: str,
    AssociatedResourceTypes: Sequence[WorkSpaceAssociatedResourceTypeType],  # (1)
) -> DescribeWorkspaceAssociationsResultTypeDef:  # (2)
    ...
  1. See WorkSpaceAssociatedResourceTypeType
  2. See DescribeWorkspaceAssociationsResultTypeDef 
# describe_workspace_associations method usage example with argument unpacking

kwargs: DescribeWorkspaceAssociationsRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
    "AssociatedResourceTypes": ...,
}

parent.describe_workspace_associations(**kwargs)
  1. See DescribeWorkspaceAssociationsRequestRequestTypeDef

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)
    ...
  1. See DescribeWorkspaceBundlesResultTypeDef 
# describe_workspace_bundles method usage example with argument unpacking

kwargs: DescribeWorkspaceBundlesRequestRequestTypeDef = {  # (1)
    "BundleIds": ...,
}

parent.describe_workspace_bundles(**kwargs)
  1. See DescribeWorkspaceBundlesRequestRequestTypeDef

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] = ...,
    WorkspaceDirectoryNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
    Filters: Sequence[DescribeWorkspaceDirectoriesFilterTypeDef] = ...,  # (1)
) -> DescribeWorkspaceDirectoriesResultTypeDef:  # (2)
    ...
  1. See DescribeWorkspaceDirectoriesFilterTypeDef
  2. See DescribeWorkspaceDirectoriesResultTypeDef 
# describe_workspace_directories method usage example with argument unpacking

kwargs: DescribeWorkspaceDirectoriesRequestRequestTypeDef = {  # (1)
    "DirectoryIds": ...,
}

parent.describe_workspace_directories(**kwargs)
  1. See DescribeWorkspaceDirectoriesRequestRequestTypeDef

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)
    ...
  1. See DescribeWorkspaceImagePermissionsResultTypeDef 
# describe_workspace_image_permissions method usage example with argument unpacking

kwargs: DescribeWorkspaceImagePermissionsRequestRequestTypeDef = {  # (1)
    "ImageId": ...,
}

parent.describe_workspace_image_permissions(**kwargs)
  1. See DescribeWorkspaceImagePermissionsRequestRequestTypeDef

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)
    ...
  1. See ImageTypeType
  2. See DescribeWorkspaceImagesResultTypeDef 
# describe_workspace_images method usage example with argument unpacking

kwargs: DescribeWorkspaceImagesRequestRequestTypeDef = {  # (1)
    "ImageIds": ...,
}

parent.describe_workspace_images(**kwargs)
  1. See DescribeWorkspaceImagesRequestRequestTypeDef

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)
    ...
  1. See DescribeWorkspaceSnapshotsResultTypeDef 
# describe_workspace_snapshots method usage example with argument unpacking

kwargs: DescribeWorkspaceSnapshotsRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
}

parent.describe_workspace_snapshots(**kwargs)
  1. See DescribeWorkspaceSnapshotsRequestRequestTypeDef

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 = ...,
    WorkspaceName: str = ...,
) -> DescribeWorkspacesResultTypeDef:  # (1)
    ...
  1. See DescribeWorkspacesResultTypeDef 
# describe_workspaces method usage example with argument unpacking

kwargs: DescribeWorkspacesRequestRequestTypeDef = {  # (1)
    "WorkspaceIds": ...,
}

parent.describe_workspaces(**kwargs)
  1. See DescribeWorkspacesRequestRequestTypeDef

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)
    ...
  1. See DescribeWorkspacesConnectionStatusResultTypeDef 
# describe_workspaces_connection_status method usage example with argument unpacking

kwargs: DescribeWorkspacesConnectionStatusRequestRequestTypeDef = {  # (1)
    "WorkspaceIds": ...,
}

parent.describe_workspaces_connection_status(**kwargs)
  1. See DescribeWorkspacesConnectionStatusRequestRequestTypeDef

describe_workspaces_pool_sessions#

Retrieves a list that describes the streaming sessions for a specified pool.

Type annotations and code completion for boto3.client("workspaces").describe_workspaces_pool_sessions method. boto3 documentation

# describe_workspaces_pool_sessions method definition

def describe_workspaces_pool_sessions(
    self,
    *,
    PoolId: str,
    UserId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeWorkspacesPoolSessionsResultTypeDef:  # (1)
    ...
  1. See DescribeWorkspacesPoolSessionsResultTypeDef 
# describe_workspaces_pool_sessions method usage example with argument unpacking

kwargs: DescribeWorkspacesPoolSessionsRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.describe_workspaces_pool_sessions(**kwargs)
  1. See DescribeWorkspacesPoolSessionsRequestRequestTypeDef

describe_workspaces_pools#

Describes the specified WorkSpaces Pools.

Type annotations and code completion for boto3.client("workspaces").describe_workspaces_pools method. boto3 documentation

# describe_workspaces_pools method definition

def describe_workspaces_pools(
    self,
    *,
    PoolIds: Sequence[str] = ...,
    Filters: Sequence[DescribeWorkspacesPoolsFilterTypeDef] = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeWorkspacesPoolsResultTypeDef:  # (2)
    ...
  1. See DescribeWorkspacesPoolsFilterTypeDef
  2. See DescribeWorkspacesPoolsResultTypeDef 
# describe_workspaces_pools method usage example with argument unpacking

kwargs: DescribeWorkspacesPoolsRequestRequestTypeDef = {  # (1)
    "PoolIds": ...,
}

parent.describe_workspaces_pools(**kwargs)
  1. See DescribeWorkspacesPoolsRequestRequestTypeDef

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)
  1. See DisassociateConnectionAliasRequestRequestTypeDef

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)
  1. See DisassociateIpGroupsRequestRequestTypeDef

disassociate_workspace_application#

Disassociates the specified application from a WorkSpace.

Type annotations and code completion for boto3.client("workspaces").disassociate_workspace_application method. boto3 documentation

# disassociate_workspace_application method definition

def disassociate_workspace_application(
    self,
    *,
    WorkspaceId: str,
    ApplicationId: str,
) -> DisassociateWorkspaceApplicationResultTypeDef:  # (1)
    ...
  1. See DisassociateWorkspaceApplicationResultTypeDef 
# disassociate_workspace_application method usage example with argument unpacking

kwargs: DisassociateWorkspaceApplicationRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
    "ApplicationId": ...,
}

parent.disassociate_workspace_application(**kwargs)
  1. See DisassociateWorkspaceApplicationRequestRequestTypeDef

Retrieves account link information.

Type annotations and code completion for boto3.client("workspaces").get_account_link method. boto3 documentation

# get_account_link method definition

def get_account_link(
    self,
    *,
    LinkId: str = ...,
    LinkedAccountId: str = ...,
) -> GetAccountLinkResultTypeDef:  # (1)
    ...
  1. See GetAccountLinkResultTypeDef 
# get_account_link method usage example with argument unpacking

kwargs: GetAccountLinkRequestRequestTypeDef = {  # (1)
    "LinkId": ...,
}

parent.get_account_link(**kwargs)
  1. See GetAccountLinkRequestRequestTypeDef

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)
    ...
  1. See DefaultImportClientBrandingAttributesTypeDef
  2. See DefaultImportClientBrandingAttributesTypeDef
  3. See DefaultImportClientBrandingAttributesTypeDef
  4. See IosImportClientBrandingAttributesTypeDef
  5. See DefaultImportClientBrandingAttributesTypeDef
  6. See DefaultImportClientBrandingAttributesTypeDef
  7. See ImportClientBrandingResultTypeDef 
# import_client_branding method usage example with argument unpacking

kwargs: ImportClientBrandingRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.import_client_branding(**kwargs)
  1. See ImportClientBrandingRequestRequestTypeDef

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)
    ...
  1. See WorkspaceImageIngestionProcessType
  2. See TagTypeDef
  3. See ApplicationType
  4. See ImportWorkspaceImageResultTypeDef 
# import_workspace_image method usage example with argument unpacking

kwargs: ImportWorkspaceImageRequestRequestTypeDef = {  # (1)
    "Ec2ImageId": ...,
    "IngestionProcess": ...,
    "ImageName": ...,
    "ImageDescription": ...,
}

parent.import_workspace_image(**kwargs)
  1. See ImportWorkspaceImageRequestRequestTypeDef

Lists all account links.

Type annotations and code completion for boto3.client("workspaces").list_account_links method. boto3 documentation

# list_account_links method definition

def list_account_links(
    self,
    *,
    LinkStatusFilter: Sequence[AccountLinkStatusEnumType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccountLinksResultTypeDef:  # (2)
    ...
  1. See AccountLinkStatusEnumType
  2. See ListAccountLinksResultTypeDef 
# list_account_links method usage example with argument unpacking

kwargs: ListAccountLinksRequestRequestTypeDef = {  # (1)
    "LinkStatusFilter": ...,
}

parent.list_account_links(**kwargs)
  1. See ListAccountLinksRequestRequestTypeDef

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)
    ...
  1. See ListAvailableManagementCidrRangesResultTypeDef 
# list_available_management_cidr_ranges method usage example with argument unpacking

kwargs: ListAvailableManagementCidrRangesRequestRequestTypeDef = {  # (1)
    "ManagementCidrRangeConstraint": ...,
}

parent.list_available_management_cidr_ranges(**kwargs)
  1. See ListAvailableManagementCidrRangesRequestRequestTypeDef

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)
    ...
  1. See MigrateWorkspaceResultTypeDef 
# migrate_workspace method usage example with argument unpacking

kwargs: MigrateWorkspaceRequestRequestTypeDef = {  # (1)
    "SourceWorkspaceId": ...,
    "BundleId": ...,
}

parent.migrate_workspace(**kwargs)
  1. See MigrateWorkspaceRequestRequestTypeDef

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]:
    ...
  1. See DedicatedTenancySupportEnumType 
# modify_account method usage example with argument unpacking

kwargs: ModifyAccountRequestRequestTypeDef = {  # (1)
    "DedicatedTenancySupport": ...,
}

parent.modify_account(**kwargs)
  1. See ModifyAccountRequestRequestTypeDef

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]:
    ...
  1. See CertificateBasedAuthPropertiesTypeDef
  2. See DeletableCertificateBasedAuthPropertyType 
# modify_certificate_based_auth_properties method usage example with argument unpacking

kwargs: ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.modify_certificate_based_auth_properties(**kwargs)
  1. See ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef

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]:
    ...
  1. See ClientPropertiesTypeDef 
# modify_client_properties method usage example with argument unpacking

kwargs: ModifyClientPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "ClientProperties": ...,
}

parent.modify_client_properties(**kwargs)
  1. See ModifyClientPropertiesRequestRequestTypeDef

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]:
    ...
  1. See SamlPropertiesTypeDef
  2. See DeletableSamlPropertyType 
# modify_saml_properties method usage example with argument unpacking

kwargs: ModifySamlPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.modify_saml_properties(**kwargs)
  1. See ModifySamlPropertiesRequestRequestTypeDef

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]:
    ...
  1. See SelfservicePermissionsTypeDef 
# modify_selfservice_permissions method usage example with argument unpacking

kwargs: ModifySelfservicePermissionsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "SelfservicePermissions": ...,
}

parent.modify_selfservice_permissions(**kwargs)
  1. See ModifySelfservicePermissionsRequestRequestTypeDef

modify_streaming_properties#

Modifies the specified streaming properties.

Type annotations and code completion for boto3.client("workspaces").modify_streaming_properties method. boto3 documentation

# modify_streaming_properties method definition

def modify_streaming_properties(
    self,
    *,
    ResourceId: str,
    StreamingProperties: StreamingPropertiesTypeDef = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See StreamingPropertiesTypeDef 
# modify_streaming_properties method usage example with argument unpacking

kwargs: ModifyStreamingPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.modify_streaming_properties(**kwargs)
  1. See ModifyStreamingPropertiesRequestRequestTypeDef

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]:
    ...
  1. See WorkspaceAccessPropertiesTypeDef 
# modify_workspace_access_properties method usage example with argument unpacking

kwargs: ModifyWorkspaceAccessPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "WorkspaceAccessProperties": ...,
}

parent.modify_workspace_access_properties(**kwargs)
  1. See ModifyWorkspaceAccessPropertiesRequestRequestTypeDef

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]:
    ...
  1. See WorkspaceCreationPropertiesTypeDef 
# modify_workspace_creation_properties method usage example with argument unpacking

kwargs: ModifyWorkspaceCreationPropertiesRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "WorkspaceCreationProperties": ...,
}

parent.modify_workspace_creation_properties(**kwargs)
  1. See ModifyWorkspaceCreationPropertiesRequestRequestTypeDef

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)
    DataReplication: DataReplicationType = ...,  # (2)
) -> dict[str, Any]:
    ...
  1. See WorkspacePropertiesTypeDef
  2. See DataReplicationType 
# modify_workspace_properties method usage example with argument unpacking

kwargs: ModifyWorkspacePropertiesRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
}

parent.modify_workspace_properties(**kwargs)
  1. See ModifyWorkspacePropertiesRequestRequestTypeDef

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]:
    ...
  1. See TargetWorkspaceStateType 
# modify_workspace_state method usage example with argument unpacking

kwargs: ModifyWorkspaceStateRequestRequestTypeDef = {  # (1)
    "WorkspaceId": ...,
    "WorkspaceState": ...,
}

parent.modify_workspace_state(**kwargs)
  1. See ModifyWorkspaceStateRequestRequestTypeDef

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)
    ...
  1. See RebootRequestTypeDef
  2. See RebootWorkspacesResultTypeDef 
# reboot_workspaces method usage example with argument unpacking

kwargs: RebootWorkspacesRequestRequestTypeDef = {  # (1)
    "RebootWorkspaceRequests": ...,
}

parent.reboot_workspaces(**kwargs)
  1. See RebootWorkspacesRequestRequestTypeDef

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)
    ...
  1. See RebuildRequestTypeDef
  2. See RebuildWorkspacesResultTypeDef 
# rebuild_workspaces method usage example with argument unpacking

kwargs: RebuildWorkspacesRequestRequestTypeDef = {  # (1)
    "RebuildWorkspaceRequests": ...,
}

parent.rebuild_workspaces(**kwargs)
  1. See RebuildWorkspacesRequestRequestTypeDef

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 = ...,
    SubnetIds: Sequence[str] = ...,
    EnableWorkDocs: bool = ...,
    EnableSelfService: bool = ...,
    Tenancy: TenancyType = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    WorkspaceDirectoryName: str = ...,
    WorkspaceDirectoryDescription: str = ...,
    UserIdentityType: UserIdentityTypeType = ...,  # (3)
    IdcInstanceArn: str = ...,
    MicrosoftEntraConfig: MicrosoftEntraConfigTypeDef = ...,  # (4)
    WorkspaceType: WorkspaceTypeType = ...,  # (5)
    ActiveDirectoryConfig: ActiveDirectoryConfigTypeDef = ...,  # (6)
) -> RegisterWorkspaceDirectoryResultTypeDef:  # (7)
    ...
  1. See TenancyType
  2. See TagTypeDef
  3. See UserIdentityTypeType
  4. See MicrosoftEntraConfigTypeDef
  5. See WorkspaceTypeType
  6. See ActiveDirectoryConfigTypeDef
  7. See RegisterWorkspaceDirectoryResultTypeDef 
# register_workspace_directory method usage example with argument unpacking

kwargs: RegisterWorkspaceDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.register_workspace_directory(**kwargs)
  1. See RegisterWorkspaceDirectoryRequestRequestTypeDef

Rejects the account link invitation.

Type annotations and code completion for boto3.client("workspaces").reject_account_link_invitation method. boto3 documentation

# reject_account_link_invitation method definition

def reject_account_link_invitation(
    self,
    *,
    LinkId: str,
    ClientToken: str = ...,
) -> RejectAccountLinkInvitationResultTypeDef:  # (1)
    ...
  1. See RejectAccountLinkInvitationResultTypeDef 
# reject_account_link_invitation method usage example with argument unpacking

kwargs: RejectAccountLinkInvitationRequestRequestTypeDef = {  # (1)
    "LinkId": ...,
}

parent.reject_account_link_invitation(**kwargs)
  1. See RejectAccountLinkInvitationRequestRequestTypeDef

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)
  1. See RestoreWorkspaceRequestRequestTypeDef

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)
  1. See RevokeIpRulesRequestRequestTypeDef

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)
    ...
  1. See StartRequestTypeDef
  2. See StartWorkspacesResultTypeDef 
# start_workspaces method usage example with argument unpacking

kwargs: StartWorkspacesRequestRequestTypeDef = {  # (1)
    "StartWorkspaceRequests": ...,
}

parent.start_workspaces(**kwargs)
  1. See StartWorkspacesRequestRequestTypeDef

start_workspaces_pool#

Starts the specified pool.

Type annotations and code completion for boto3.client("workspaces").start_workspaces_pool method. boto3 documentation

# start_workspaces_pool method definition

def start_workspaces_pool(
    self,
    *,
    PoolId: str,
) -> dict[str, Any]:
    ...
# start_workspaces_pool method usage example with argument unpacking

kwargs: StartWorkspacesPoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.start_workspaces_pool(**kwargs)
  1. See StartWorkspacesPoolRequestRequestTypeDef

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)
    ...
  1. See StopRequestTypeDef
  2. See StopWorkspacesResultTypeDef 
# stop_workspaces method usage example with argument unpacking

kwargs: StopWorkspacesRequestRequestTypeDef = {  # (1)
    "StopWorkspaceRequests": ...,
}

parent.stop_workspaces(**kwargs)
  1. See StopWorkspacesRequestRequestTypeDef

stop_workspaces_pool#

Stops the specified pool.

Type annotations and code completion for boto3.client("workspaces").stop_workspaces_pool method. boto3 documentation

# stop_workspaces_pool method definition

def stop_workspaces_pool(
    self,
    *,
    PoolId: str,
) -> dict[str, Any]:
    ...
# stop_workspaces_pool method usage example with argument unpacking

kwargs: StopWorkspacesPoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.stop_workspaces_pool(**kwargs)
  1. See StopWorkspacesPoolRequestRequestTypeDef

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)
    ...
  1. See TerminateRequestTypeDef
  2. See TerminateWorkspacesResultTypeDef 
# terminate_workspaces method usage example with argument unpacking

kwargs: TerminateWorkspacesRequestRequestTypeDef = {  # (1)
    "TerminateWorkspaceRequests": ...,
}

parent.terminate_workspaces(**kwargs)
  1. See TerminateWorkspacesRequestRequestTypeDef

terminate_workspaces_pool#

Terminates the specified pool.

Type annotations and code completion for boto3.client("workspaces").terminate_workspaces_pool method. boto3 documentation

# terminate_workspaces_pool method definition

def terminate_workspaces_pool(
    self,
    *,
    PoolId: str,
) -> dict[str, Any]:
    ...
# terminate_workspaces_pool method usage example with argument unpacking

kwargs: TerminateWorkspacesPoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.terminate_workspaces_pool(**kwargs)
  1. See TerminateWorkspacesPoolRequestRequestTypeDef

terminate_workspaces_pool_session#

Terminates the pool session.

Type annotations and code completion for boto3.client("workspaces").terminate_workspaces_pool_session method. boto3 documentation

# terminate_workspaces_pool_session method definition

def terminate_workspaces_pool_session(
    self,
    *,
    SessionId: str,
) -> dict[str, Any]:
    ...
# terminate_workspaces_pool_session method usage example with argument unpacking

kwargs: TerminateWorkspacesPoolSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.terminate_workspaces_pool_session(**kwargs)
  1. See TerminateWorkspacesPoolSessionRequestRequestTypeDef

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)
  1. See UpdateConnectClientAddInRequestRequestTypeDef

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]:
    ...
  1. See ConnectionAliasPermissionTypeDef 
# update_connection_alias_permission method usage example with argument unpacking

kwargs: UpdateConnectionAliasPermissionRequestRequestTypeDef = {  # (1)
    "AliasId": ...,
    "ConnectionAliasPermission": ...,
}

parent.update_connection_alias_permission(**kwargs)
  1. See UpdateConnectionAliasPermissionRequestRequestTypeDef

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. boto3 documentation

# update_rules_of_ip_group method definition

def update_rules_of_ip_group(
    self,
    *,
    GroupId: str,
    UserRules: Sequence[IpRuleItemTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See IpRuleItemTypeDef 
# update_rules_of_ip_group method usage example with argument unpacking

kwargs: UpdateRulesOfIpGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
    "UserRules": ...,
}

parent.update_rules_of_ip_group(**kwargs)
  1. See UpdateRulesOfIpGroupRequestRequestTypeDef

update_workspace_bundle#

Updates a WorkSpace bundle with a new image.

Type annotations and code completion for boto3.client("workspaces").update_workspace_bundle method. boto3 documentation

# update_workspace_bundle method definition

def update_workspace_bundle(
    self,
    *,
    BundleId: str = ...,
    ImageId: str = ...,
) -> dict[str, Any]:
    ...
# update_workspace_bundle method usage example with argument unpacking

kwargs: UpdateWorkspaceBundleRequestRequestTypeDef = {  # (1)
    "BundleId": ...,
}

parent.update_workspace_bundle(**kwargs)
  1. See UpdateWorkspaceBundleRequestRequestTypeDef

update_workspace_image_permission#

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image.

Type annotations and code completion for boto3.client("workspaces").update_workspace_image_permission method. boto3 documentation

# update_workspace_image_permission method definition

def update_workspace_image_permission(
    self,
    *,
    ImageId: str,
    AllowCopyImage: bool,
    SharedAccountId: str,
) -> dict[str, Any]:
    ...
# update_workspace_image_permission method usage example with argument unpacking

kwargs: UpdateWorkspaceImagePermissionRequestRequestTypeDef = {  # (1)
    "ImageId": ...,
    "AllowCopyImage": ...,
    "SharedAccountId": ...,
}

parent.update_workspace_image_permission(**kwargs)
  1. See UpdateWorkspaceImagePermissionRequestRequestTypeDef

update_workspaces_pool#

Updates the specified pool.

Type annotations and code completion for boto3.client("workspaces").update_workspaces_pool method. boto3 documentation

# update_workspaces_pool method definition

def update_workspaces_pool(
    self,
    *,
    PoolId: str,
    Description: str = ...,
    BundleId: str = ...,
    DirectoryId: str = ...,
    Capacity: CapacityTypeDef = ...,  # (1)
    ApplicationSettings: ApplicationSettingsRequestTypeDef = ...,  # (2)
    TimeoutSettings: TimeoutSettingsTypeDef = ...,  # (3)
) -> UpdateWorkspacesPoolResultTypeDef:  # (4)
    ...
  1. See CapacityTypeDef
  2. See ApplicationSettingsRequestTypeDef
  3. See TimeoutSettingsTypeDef
  4. See UpdateWorkspacesPoolResultTypeDef 
# update_workspaces_pool method usage example with argument unpacking

kwargs: UpdateWorkspacesPoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.update_workspaces_pool(**kwargs)
  1. See UpdateWorkspacesPoolRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("workspaces").get_paginator method with overloads.