WorkSpacesThinClientClient

Index > WorkSpacesThinClient > WorkSpacesThinClientClient

Auto-generated documentation for WorkSpacesThinClient type annotations stubs module mypy-boto3-workspaces-thin-client.

WorkSpacesThinClientClient

Type annotations and code completion for boto3.client("workspaces-thin-client"). boto3 documentation

# WorkSpacesThinClientClient usage example

from boto3.session import Session
from mypy_boto3_workspaces_thin_client.client import WorkSpacesThinClientClient

def get_workspaces-thin-client_client() -> WorkSpacesThinClientClient:
    return Session().client("workspaces-thin-client")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("workspaces-thin-client").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("workspaces-thin-client")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_workspaces_thin_client.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("workspaces-thin-client").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_environment

Creates an environment for your thin client devices.

Type annotations and code completion for boto3.client("workspaces-thin-client").create_environment method. boto3 documentation

# create_environment method definition

def create_environment(
    self,
    *,
    desktopArn: str,
    name: str = ...,
    desktopEndpoint: str = ...,
    softwareSetUpdateSchedule: SoftwareSetUpdateScheduleType = ...,  # (1)
    maintenanceWindow: MaintenanceWindowTypeDef = ...,  # (2)
    softwareSetUpdateMode: SoftwareSetUpdateModeType = ...,  # (3)
    desiredSoftwareSetId: str = ...,
    kmsKeyArn: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    deviceCreationTags: Mapping[str, str] = ...,
) -> CreateEnvironmentResponseTypeDef:  # (4)
    ...

1. See SoftwareSetUpdateScheduleType
2. See MaintenanceWindowTypeDef
3. See SoftwareSetUpdateModeType
4. See CreateEnvironmentResponseTypeDef

# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentRequestRequestTypeDef = {  # (1)
    "desktopArn": ...,
}

parent.create_environment(**kwargs)

1. See CreateEnvironmentRequestRequestTypeDef

delete_device

Deletes a thin client device.

Type annotations and code completion for boto3.client("workspaces-thin-client").delete_device method. boto3 documentation

# delete_device method definition

def delete_device(
    self,
    *,
    id: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_device method usage example with argument unpacking

kwargs: DeleteDeviceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_device(**kwargs)

1. See DeleteDeviceRequestRequestTypeDef

delete_environment

Deletes an environment.

Type annotations and code completion for boto3.client("workspaces-thin-client").delete_environment method. boto3 documentation

# delete_environment method definition

def delete_environment(
    self,
    *,
    id: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_environment method usage example with argument unpacking

kwargs: DeleteEnvironmentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_environment(**kwargs)

1. See DeleteEnvironmentRequestRequestTypeDef

deregister_device

Deregisters a thin client device.

Type annotations and code completion for boto3.client("workspaces-thin-client").deregister_device method. boto3 documentation

# deregister_device method definition

def deregister_device(
    self,
    *,
    id: str,
    targetDeviceStatus: TargetDeviceStatusType = ...,  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See TargetDeviceStatusType

# deregister_device method usage example with argument unpacking

kwargs: DeregisterDeviceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.deregister_device(**kwargs)

1. See DeregisterDeviceRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("workspaces-thin-client").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:
    ...

get_device

Returns information for a thin client device.

Type annotations and code completion for boto3.client("workspaces-thin-client").get_device method. boto3 documentation

# get_device method definition

def get_device(
    self,
    *,
    id: str,
) -> GetDeviceResponseTypeDef:  # (1)
    ...

1. See GetDeviceResponseTypeDef

# get_device method usage example with argument unpacking

kwargs: GetDeviceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_device(**kwargs)

1. See GetDeviceRequestRequestTypeDef

get_environment

Returns information for an environment.

Type annotations and code completion for boto3.client("workspaces-thin-client").get_environment method. boto3 documentation

# get_environment method definition

def get_environment(
    self,
    *,
    id: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...

1. See GetEnvironmentResponseTypeDef

# get_environment method usage example with argument unpacking

kwargs: GetEnvironmentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_environment(**kwargs)

1. See GetEnvironmentRequestRequestTypeDef

get_software_set

Returns information for a software set.

Type annotations and code completion for boto3.client("workspaces-thin-client").get_software_set method. boto3 documentation

# get_software_set method definition

def get_software_set(
    self,
    *,
    id: str,
) -> GetSoftwareSetResponseTypeDef:  # (1)
    ...

1. See GetSoftwareSetResponseTypeDef

# get_software_set method usage example with argument unpacking

kwargs: GetSoftwareSetRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_software_set(**kwargs)

1. See GetSoftwareSetRequestRequestTypeDef

list_devices

Returns a list of thin client devices.

Type annotations and code completion for boto3.client("workspaces-thin-client").list_devices method. boto3 documentation

# list_devices method definition

def list_devices(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...

1. See ListDevicesResponseTypeDef

# list_devices method usage example with argument unpacking

kwargs: ListDevicesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_devices(**kwargs)

1. See ListDevicesRequestRequestTypeDef

list_environments

Returns a list of environments.

Type annotations and code completion for boto3.client("workspaces-thin-client").list_environments method. boto3 documentation

# list_environments method definition

def list_environments(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentsResponseTypeDef:  # (1)
    ...

1. See ListEnvironmentsResponseTypeDef

# list_environments method usage example with argument unpacking

kwargs: ListEnvironmentsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_environments(**kwargs)

1. See ListEnvironmentsRequestRequestTypeDef

list_software_sets

Returns a list of software sets.

Type annotations and code completion for boto3.client("workspaces-thin-client").list_software_sets method. boto3 documentation

# list_software_sets method definition

def list_software_sets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSoftwareSetsResponseTypeDef:  # (1)
    ...

1. See ListSoftwareSetsResponseTypeDef

# list_software_sets method usage example with argument unpacking

kwargs: ListSoftwareSetsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_software_sets(**kwargs)

1. See ListSoftwareSetsRequestRequestTypeDef

list_tags_for_resource

Returns a list of tags for a resource.

Type annotations and code completion for boto3.client("workspaces-thin-client").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified resource.

Type annotations and code completion for boto3.client("workspaces-thin-client").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag or tags from a resource.

Type annotations and code completion for boto3.client("workspaces-thin-client").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_device

Updates a thin client device.

Type annotations and code completion for boto3.client("workspaces-thin-client").update_device method. boto3 documentation

# update_device method definition

def update_device(
    self,
    *,
    id: str,
    name: str = ...,
    desiredSoftwareSetId: str = ...,
    softwareSetUpdateSchedule: SoftwareSetUpdateScheduleType = ...,  # (1)
) -> UpdateDeviceResponseTypeDef:  # (2)
    ...

1. See SoftwareSetUpdateScheduleType
2. See UpdateDeviceResponseTypeDef

# update_device method usage example with argument unpacking

kwargs: UpdateDeviceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_device(**kwargs)

1. See UpdateDeviceRequestRequestTypeDef

update_environment

Updates an environment.

Type annotations and code completion for boto3.client("workspaces-thin-client").update_environment method. boto3 documentation

# update_environment method definition

def update_environment(
    self,
    *,
    id: str,
    name: str = ...,
    desktopArn: str = ...,
    desktopEndpoint: str = ...,
    softwareSetUpdateSchedule: SoftwareSetUpdateScheduleType = ...,  # (1)
    maintenanceWindow: MaintenanceWindowTypeDef = ...,  # (2)
    softwareSetUpdateMode: SoftwareSetUpdateModeType = ...,  # (3)
    desiredSoftwareSetId: str = ...,
    deviceCreationTags: Mapping[str, str] = ...,
) -> UpdateEnvironmentResponseTypeDef:  # (4)
    ...

1. See SoftwareSetUpdateScheduleType
2. See MaintenanceWindowTypeDef
3. See SoftwareSetUpdateModeType
4. See UpdateEnvironmentResponseTypeDef

# update_environment method usage example with argument unpacking

kwargs: UpdateEnvironmentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_environment(**kwargs)

1. See UpdateEnvironmentRequestRequestTypeDef

update_software_set

Updates a software set.

Type annotations and code completion for boto3.client("workspaces-thin-client").update_software_set method. boto3 documentation

# update_software_set method definition

def update_software_set(
    self,
    *,
    id: str,
    validationStatus: SoftwareSetValidationStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See SoftwareSetValidationStatusType

# update_software_set method usage example with argument unpacking

kwargs: UpdateSoftwareSetRequestRequestTypeDef = {  # (1)
    "id": ...,
    "validationStatus": ...,
}

parent.update_software_set(**kwargs)

1. See UpdateSoftwareSetRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_devices") -> ListDevicesPaginator
• client.get_paginator("list_environments") -> ListEnvironmentsPaginator
• client.get_paginator("list_software_sets") -> ListSoftwareSetsPaginator