WorkspacesInstancesClient

Index > WorkspacesInstances > WorkspacesInstancesClient

Auto-generated documentation for WorkspacesInstances type annotations stubs module mypy-boto3-workspaces-instances.

WorkspacesInstancesClient

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

# WorkspacesInstancesClient usage example

from boto3.session import Session
from mypy_boto3_workspaces_instances.client import WorkspacesInstancesClient

def get_workspaces-instances_client() -> WorkspacesInstancesClient:
    return Session().client("workspaces-instances")

Exceptions

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

# Exceptions.exceptions usage example

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

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_instances.client import Exceptions

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

Methods

can_paginate

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

associate_volume

Attaches a volume to a WorkSpace Instance.

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

# associate_volume method definition

def associate_volume(
    self,
    *,
    WorkspaceInstanceId: str,
    VolumeId: str,
    Device: str,
) -> Dict[str, Any]:
    ...

# associate_volume method usage example with argument unpacking

kwargs: AssociateVolumeRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
    "VolumeId": ...,
    "Device": ...,
}

parent.associate_volume(**kwargs)

1. See AssociateVolumeRequestTypeDef

create_volume

Creates a new volume for WorkSpace Instances.

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

# create_volume method definition

def create_volume(
    self,
    *,
    AvailabilityZone: str,
    ClientToken: str = ...,
    Encrypted: bool = ...,
    Iops: int = ...,
    KmsKeyId: str = ...,
    SizeInGB: int = ...,
    SnapshotId: str = ...,
    TagSpecifications: Sequence[TagSpecificationTypeDef] = ...,  # (1)
    Throughput: int = ...,
    VolumeType: VolumeTypeEnumType = ...,  # (2)
) -> CreateVolumeResponseTypeDef:  # (3)
    ...

1. See Sequence[TagSpecificationTypeDef]
2. See VolumeTypeEnumType
3. See CreateVolumeResponseTypeDef

# create_volume method usage example with argument unpacking

kwargs: CreateVolumeRequestTypeDef = {  # (1)
    "AvailabilityZone": ...,
}

parent.create_volume(**kwargs)

1. See CreateVolumeRequestTypeDef

create_workspace_instance

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

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

# create_workspace_instance method definition

def create_workspace_instance(
    self,
    *,
    ManagedInstance: ManagedInstanceRequestTypeDef,  # (1)
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateWorkspaceInstanceResponseTypeDef:  # (3)
    ...

1. See ManagedInstanceRequestTypeDef
2. See Sequence[TagTypeDef]
3. See CreateWorkspaceInstanceResponseTypeDef

# create_workspace_instance method usage example with argument unpacking

kwargs: CreateWorkspaceInstanceRequestTypeDef = {  # (1)
    "ManagedInstance": ...,
}

parent.create_workspace_instance(**kwargs)

1. See CreateWorkspaceInstanceRequestTypeDef

delete_volume

Deletes a specified volume.

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

# delete_volume method definition

def delete_volume(
    self,
    *,
    VolumeId: str,
) -> Dict[str, Any]:
    ...

# delete_volume method usage example with argument unpacking

kwargs: DeleteVolumeRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.delete_volume(**kwargs)

1. See DeleteVolumeRequestTypeDef

delete_workspace_instance

Deletes the specified WorkSpace.

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

# delete_workspace_instance method definition

def delete_workspace_instance(
    self,
    *,
    WorkspaceInstanceId: str,
) -> Dict[str, Any]:
    ...

# delete_workspace_instance method usage example with argument unpacking

kwargs: DeleteWorkspaceInstanceRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
}

parent.delete_workspace_instance(**kwargs)

1. See DeleteWorkspaceInstanceRequestTypeDef

disassociate_volume

Detaches a volume from a WorkSpace Instance.

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

# disassociate_volume method definition

def disassociate_volume(
    self,
    *,
    WorkspaceInstanceId: str,
    VolumeId: str,
    Device: str = ...,
    DisassociateMode: DisassociateModeEnumType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See DisassociateModeEnumType

# disassociate_volume method usage example with argument unpacking

kwargs: DisassociateVolumeRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
    "VolumeId": ...,
}

parent.disassociate_volume(**kwargs)

1. See DisassociateVolumeRequestTypeDef

get_workspace_instance

Retrieves detailed information about a specific WorkSpace Instance.

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

# get_workspace_instance method definition

def get_workspace_instance(
    self,
    *,
    WorkspaceInstanceId: str,
) -> GetWorkspaceInstanceResponseTypeDef:  # (1)
    ...

1. See GetWorkspaceInstanceResponseTypeDef

# get_workspace_instance method usage example with argument unpacking

kwargs: GetWorkspaceInstanceRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
}

parent.get_workspace_instance(**kwargs)

1. See GetWorkspaceInstanceRequestTypeDef

list_instance_types

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

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

# list_instance_types method definition

def list_instance_types(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInstanceTypesResponseTypeDef:  # (1)
    ...

1. See ListInstanceTypesResponseTypeDef

# list_instance_types method usage example with argument unpacking

kwargs: ListInstanceTypesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_instance_types(**kwargs)

1. See ListInstanceTypesRequestTypeDef

list_regions

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

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

# list_regions method definition

def list_regions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRegionsResponseTypeDef:  # (1)
    ...

1. See ListRegionsResponseTypeDef

# list_regions method usage example with argument unpacking

kwargs: ListRegionsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_regions(**kwargs)

1. See ListRegionsRequestTypeDef

list_tags_for_resource

Retrieves tags for a WorkSpace Instance.

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

# list_tags_for_resource method definition

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_workspace_instances

Retrieves a collection of WorkSpaces Instances based on specified filters.

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

# list_workspace_instances method definition

def list_workspace_instances(
    self,
    *,
    ProvisionStates: Sequence[ProvisionStateEnumType] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWorkspaceInstancesResponseTypeDef:  # (2)
    ...

1. See Sequence[ProvisionStateEnumType]
2. See ListWorkspaceInstancesResponseTypeDef

# list_workspace_instances method usage example with argument unpacking

kwargs: ListWorkspaceInstancesRequestTypeDef = {  # (1)
    "ProvisionStates": ...,
}

parent.list_workspace_instances(**kwargs)

1. See ListWorkspaceInstancesRequestTypeDef

tag_resource

Adds tags to a WorkSpace Instance.

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

# tag_resource method definition

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

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes tags from a WorkSpace Instance.

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

# untag_resource method definition

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

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "WorkspaceInstanceId": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

get_paginator

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

• client.get_paginator("list_instance_types") -> ListInstanceTypesPaginator
• client.get_paginator("list_regions") -> ListRegionsPaginator
• client.get_paginator("list_workspace_instances") -> ListWorkspaceInstancesPaginator