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

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.

Usage example

client = boto3.client("workspaces")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.InvalidParameterValuesException,
    client.InvalidResourceStateException,
    client.OperationInProgressException,
    client.OperationNotSupportedException,
    client.ResourceAlreadyExistsException,
    client.ResourceAssociatedException,
    client.ResourceCreationFailedException,
    client.ResourceLimitExceededException,
    client.ResourceNotFoundException,
    client.ResourceUnavailableException,
    client.UnsupportedNetworkConfigurationException,
    client.UnsupportedWorkspaceConfigurationException,
    client.WorkspacesDefaultRoleNotFoundException,
) as e:
    print(e)

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

Method definition

def associate_connection_alias(
    self,
    *,
    AliasId: str,
    ResourceId: str,
) -> AssociateConnectionAliasResultTypeDef:  # (1)
    ...

1. See AssociateConnectionAliasResultTypeDef

Usage example with kwargs

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

Method definition

def associate_ip_groups(
    self,
    *,
    DirectoryId: str,
    GroupIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.associate_ip_groups(**kwargs)

1. See AssociateIpGroupsRequestRequestTypeDef

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

Method definition

def authorize_ip_rules(
    self,
    *,
    GroupId: str,
    UserRules: Sequence[IpRuleItemTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See IpRuleItemTypeDef

Usage example with kwargs

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

parent.authorize_ip_rules(**kwargs)

1. See AuthorizeIpRulesRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

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

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

Usage example with kwargs

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

parent.copy_workspace_image(**kwargs)

1. See CopyWorkspaceImageRequestRequestTypeDef

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

Method definition

def create_connect_client_add_in(
    self,
    *,
    ResourceId: str,
    Name: str,
    URL: str,
) -> CreateConnectClientAddInResultTypeDef:  # (1)
    ...

1. See CreateConnectClientAddInResultTypeDef

Usage example with kwargs

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

Method definition

def create_connection_alias(
    self,
    *,
    ConnectionString: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateConnectionAliasResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateConnectionAliasResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def create_standby_workspaces(
    self,
    *,
    PrimaryRegion: str,
    StandbyWorkspaces: Sequence[StandbyWorkspaceTypeDef],  # (1)
) -> CreateStandbyWorkspacesResultTypeDef:  # (2)
    ...

1. See StandbyWorkspaceTypeDef
2. See CreateStandbyWorkspacesResultTypeDef

Usage example with kwargs

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

Method definition

def create_tags(
    self,
    *,
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def create_workspaces(
    self,
    *,
    Workspaces: Sequence[WorkspaceRequestTypeDef],  # (1)
) -> CreateWorkspacesResultTypeDef:  # (2)
    ...

1. See WorkspaceRequestTypeDef
2. See CreateWorkspacesResultTypeDef

Usage example with kwargs

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

parent.create_workspaces(**kwargs)

1. See CreateWorkspacesRequestRequestTypeDef

delete_client_branding

Deletes customized client branding.

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

Method definition

def delete_client_branding(
    self,
    *,
    ResourceId: str,
    Platforms: Sequence[ClientDeviceTypeType],  # (1)
) -> Dict[str, Any]:
    ...

1. See ClientDeviceTypeType

Usage example with kwargs

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

Method definition

def delete_connect_client_add_in(
    self,
    *,
    AddInId: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_connection_alias(
    self,
    *,
    AliasId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_ip_group(
    self,
    *,
    GroupId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_tags(
    self,
    *,
    ResourceId: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_workspace_bundle(
    self,
    *,
    BundleId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_workspace_image(
    self,
    *,
    ImageId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_workspace_image(**kwargs)

1. See DeleteWorkspaceImageRequestRequestTypeDef

deregister_workspace_directory

Deregisters the specified directory.

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

Method definition

def deregister_workspace_directory(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

Method definition

def describe_account_modifications(
    self,
    *,
    NextToken: str = ...,
) -> DescribeAccountModificationsResultTypeDef:  # (1)
    ...

1. See DescribeAccountModificationsResultTypeDef

Usage example with kwargs

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

parent.describe_account_modifications(**kwargs)

1. See DescribeAccountModificationsRequestRequestTypeDef

describe_client_branding

Describes the specified client branding.

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

Method definition

def describe_client_branding(
    self,
    *,
    ResourceId: str,
) -> DescribeClientBrandingResultTypeDef:  # (1)
    ...

1. See DescribeClientBrandingResultTypeDef

Usage example with kwargs

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

Method definition

def describe_client_properties(
    self,
    *,
    ResourceIds: Sequence[str],
) -> DescribeClientPropertiesResultTypeDef:  # (1)
    ...

1. See DescribeClientPropertiesResultTypeDef

Usage example with kwargs

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

Method definition

def describe_connect_client_add_ins(
    self,
    *,
    ResourceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeConnectClientAddInsResultTypeDef:  # (1)
    ...

1. See DescribeConnectClientAddInsResultTypeDef

Usage example with kwargs

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

Method definition

def describe_connection_alias_permissions(
    self,
    *,
    AliasId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeConnectionAliasPermissionsResultTypeDef:  # (1)
    ...

1. See DescribeConnectionAliasPermissionsResultTypeDef

Usage example with kwargs

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

Method definition

def describe_connection_aliases(
    self,
    *,
    AliasIds: Sequence[str] = ...,
    ResourceId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeConnectionAliasesResultTypeDef:  # (1)
    ...

1. See DescribeConnectionAliasesResultTypeDef

Usage example with kwargs

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

parent.describe_connection_aliases(**kwargs)

1. See DescribeConnectionAliasesRequestRequestTypeDef

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

Method definition

def describe_ip_groups(
    self,
    *,
    GroupIds: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeIpGroupsResultTypeDef:  # (1)
    ...

1. See DescribeIpGroupsResultTypeDef

Usage example with kwargs

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

Method definition

def describe_tags(
    self,
    *,
    ResourceId: str,
) -> DescribeTagsResultTypeDef:  # (1)
    ...

1. See DescribeTagsResultTypeDef

Usage example with kwargs

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

parent.describe_tags(**kwargs)

1. See DescribeTagsRequestRequestTypeDef

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

Method definition

def describe_workspace_bundles(
    self,
    *,
    BundleIds: Sequence[str] = ...,
    Owner: str = ...,
    NextToken: str = ...,
) -> DescribeWorkspaceBundlesResultTypeDef:  # (1)
    ...

1. See DescribeWorkspaceBundlesResultTypeDef

Usage example with kwargs

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

Method definition

def describe_workspace_directories(
    self,
    *,
    DirectoryIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeWorkspaceDirectoriesResultTypeDef:  # (1)
    ...

1. See DescribeWorkspaceDirectoriesResultTypeDef

Usage example with kwargs

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

Method definition

def describe_workspace_image_permissions(
    self,
    *,
    ImageId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeWorkspaceImagePermissionsResultTypeDef:  # (1)
    ...

1. See DescribeWorkspaceImagePermissionsResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def describe_workspace_snapshots(
    self,
    *,
    WorkspaceId: str,
) -> DescribeWorkspaceSnapshotsResultTypeDef:  # (1)
    ...

1. See DescribeWorkspaceSnapshotsResultTypeDef

Usage example with kwargs

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

Method definition

def describe_workspaces(
    self,
    *,
    WorkspaceIds: Sequence[str] = ...,
    DirectoryId: str = ...,
    UserName: str = ...,
    BundleId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeWorkspacesResultTypeDef:  # (1)
    ...

1. See DescribeWorkspacesResultTypeDef

Usage example with kwargs

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

Method definition

def describe_workspaces_connection_status(
    self,
    *,
    WorkspaceIds: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeWorkspacesConnectionStatusResultTypeDef:  # (1)
    ...

1. See DescribeWorkspacesConnectionStatusResultTypeDef

Usage example with kwargs

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

parent.describe_workspaces_connection_status(**kwargs)

1. See DescribeWorkspacesConnectionStatusRequestRequestTypeDef

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

Method definition

def disassociate_connection_alias(
    self,
    *,
    AliasId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def disassociate_ip_groups(
    self,
    *,
    DirectoryId: str,
    GroupIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_ip_groups(**kwargs)

1. See DisassociateIpGroupsRequestRequestTypeDef

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

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

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

Usage example with kwargs

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

parent.import_client_branding(**kwargs)

1. See ImportClientBrandingRequestRequestTypeDef

import_workspace_image

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.

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

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

Usage example with kwargs

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

parent.import_workspace_image(**kwargs)

1. See ImportWorkspaceImageRequestRequestTypeDef

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

Method definition

def list_available_management_cidr_ranges(
    self,
    *,
    ManagementCidrRangeConstraint: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAvailableManagementCidrRangesResultTypeDef:  # (1)
    ...

1. See ListAvailableManagementCidrRangesResultTypeDef

Usage example with kwargs

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

Method definition

def migrate_workspace(
    self,
    *,
    SourceWorkspaceId: str,
    BundleId: str,
) -> MigrateWorkspaceResultTypeDef:  # (1)
    ...

1. See MigrateWorkspaceResultTypeDef

Usage example with kwargs

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

Method definition

def modify_account(
    self,
    *,
    DedicatedTenancySupport: DedicatedTenancySupportEnumType = ...,  # (1)
    DedicatedTenancyManagementCidrRange: str = ...,
) -> Dict[str, Any]:
    ...

1. See DedicatedTenancySupportEnumType

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def modify_client_properties(
    self,
    *,
    ResourceId: str,
    ClientProperties: ClientPropertiesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See ClientPropertiesTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def modify_selfservice_permissions(
    self,
    *,
    ResourceId: str,
    SelfservicePermissions: SelfservicePermissionsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See SelfservicePermissionsTypeDef

Usage example with kwargs

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

parent.modify_selfservice_permissions(**kwargs)

1. See ModifySelfservicePermissionsRequestRequestTypeDef

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

Method definition

def modify_workspace_access_properties(
    self,
    *,
    ResourceId: str,
    WorkspaceAccessProperties: WorkspaceAccessPropertiesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See WorkspaceAccessPropertiesTypeDef

Usage example with kwargs

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

Method definition

def modify_workspace_creation_properties(
    self,
    *,
    ResourceId: str,
    WorkspaceCreationProperties: WorkspaceCreationPropertiesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See WorkspaceCreationPropertiesTypeDef

Usage example with kwargs

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

Method definition

def modify_workspace_properties(
    self,
    *,
    WorkspaceId: str,
    WorkspaceProperties: WorkspacePropertiesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See WorkspacePropertiesTypeDef

Usage example with kwargs

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

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

Method definition

def modify_workspace_state(
    self,
    *,
    WorkspaceId: str,
    WorkspaceState: TargetWorkspaceStateType,  # (1)
) -> Dict[str, Any]:
    ...

1. See TargetWorkspaceStateType

Usage example with kwargs

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

Method definition

def reboot_workspaces(
    self,
    *,
    RebootWorkspaceRequests: Sequence[RebootRequestTypeDef],  # (1)
) -> RebootWorkspacesResultTypeDef:  # (2)
    ...

1. See RebootRequestTypeDef
2. See RebootWorkspacesResultTypeDef

Usage example with kwargs

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

Method definition

def rebuild_workspaces(
    self,
    *,
    RebuildWorkspaceRequests: Sequence[RebuildRequestTypeDef],  # (1)
) -> RebuildWorkspacesResultTypeDef:  # (2)
    ...

1. See RebuildRequestTypeDef
2. See RebuildWorkspacesResultTypeDef

Usage example with kwargs

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

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

1. See TenancyType
2. See TagTypeDef

Usage example with kwargs

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

parent.register_workspace_directory(**kwargs)

1. See RegisterWorkspaceDirectoryRequestRequestTypeDef

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

Method definition

def restore_workspace(
    self,
    *,
    WorkspaceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def revoke_ip_rules(
    self,
    *,
    GroupId: str,
    UserRules: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def start_workspaces(
    self,
    *,
    StartWorkspaceRequests: Sequence[StartRequestTypeDef],  # (1)
) -> StartWorkspacesResultTypeDef:  # (2)
    ...

1. See StartRequestTypeDef
2. See StartWorkspacesResultTypeDef

Usage example with kwargs

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

parent.start_workspaces(**kwargs)

1. See StartWorkspacesRequestRequestTypeDef

stop_workspaces

Stops the specified WorkSpaces.

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

Method definition

def stop_workspaces(
    self,
    *,
    StopWorkspaceRequests: Sequence[StopRequestTypeDef],  # (1)
) -> StopWorkspacesResultTypeDef:  # (2)
    ...

1. See StopRequestTypeDef
2. See StopWorkspacesResultTypeDef

Usage example with kwargs

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

parent.stop_workspaces(**kwargs)

1. See StopWorkspacesRequestRequestTypeDef

terminate_workspaces

Terminates the specified WorkSpaces.

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

Method definition

def terminate_workspaces(
    self,
    *,
    TerminateWorkspaceRequests: Sequence[TerminateRequestTypeDef],  # (1)
) -> TerminateWorkspacesResultTypeDef:  # (2)
    ...

1. See TerminateRequestTypeDef
2. See TerminateWorkspacesResultTypeDef

Usage example with kwargs

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

parent.terminate_workspaces(**kwargs)

1. See TerminateWorkspacesRequestRequestTypeDef

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

Method definition

def update_connect_client_add_in(
    self,
    *,
    AddInId: str,
    ResourceId: str,
    Name: str = ...,
    URL: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def update_connection_alias_permission(
    self,
    *,
    AliasId: str,
    ConnectionAliasPermission: ConnectionAliasPermissionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See ConnectionAliasPermissionTypeDef

Usage example with kwargs

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

Method definition

def update_rules_of_ip_group(
    self,
    *,
    GroupId: str,
    UserRules: Sequence[IpRuleItemTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See IpRuleItemTypeDef

Usage example with kwargs

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

Method definition

def update_workspace_bundle(
    self,
    *,
    BundleId: str = ...,
    ImageId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def update_workspace_image_permission(
    self,
    *,
    ImageId: str,
    AllowCopyImage: bool,
    SharedAccountId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_workspace_image_permission(**kwargs)

1. See UpdateWorkspaceImagePermissionRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_account_modifications") -> DescribeAccountModificationsPaginator
• client.get_paginator("describe_ip_groups") -> DescribeIpGroupsPaginator
• client.get_paginator("describe_workspace_bundles") -> DescribeWorkspaceBundlesPaginator
• client.get_paginator("describe_workspace_directories") -> DescribeWorkspaceDirectoriesPaginator
• client.get_paginator("describe_workspace_images") -> DescribeWorkspaceImagesPaginator
• client.get_paginator("describe_workspaces") -> DescribeWorkspacesPaginator
• client.get_paginator("describe_workspaces_connection_status") -> DescribeWorkspacesConnectionStatusPaginator
• client.get_paginator("list_available_management_cidr_ranges") -> ListAvailableManagementCidrRangesPaginator