Skip to content

Type definitions#

Index > WorkSpacesThinClient > Type definitions

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

MaintenanceWindowUnionTypeDef#

# MaintenanceWindowUnionTypeDef definition

MaintenanceWindowUnionTypeDef = Union[
    MaintenanceWindowTypeDef,  # (1)
    MaintenanceWindowExtraOutputTypeDef,  # (2)
]
  1. See MaintenanceWindowTypeDef
  2. See MaintenanceWindowExtraOutputTypeDef

MaintenanceWindowTypeDef#

# MaintenanceWindowTypeDef definition

class MaintenanceWindowTypeDef(TypedDict):
    type: NotRequired[MaintenanceWindowTypeType],  # (1)
    startTimeHour: NotRequired[int],
    startTimeMinute: NotRequired[int],
    endTimeHour: NotRequired[int],
    endTimeMinute: NotRequired[int],
    daysOfTheWeek: NotRequired[Sequence[DayOfWeekType]],  # (2)
    applyTimeOf: NotRequired[ApplyTimeOfType],  # (3)
  1. See MaintenanceWindowTypeType
  2. See DayOfWeekType
  3. See ApplyTimeOfType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteDeviceRequestRequestTypeDef#

# DeleteDeviceRequestRequestTypeDef definition

class DeleteDeviceRequestRequestTypeDef(TypedDict):
    id: str,
    clientToken: NotRequired[str],

DeleteEnvironmentRequestRequestTypeDef#

# DeleteEnvironmentRequestRequestTypeDef definition

class DeleteEnvironmentRequestRequestTypeDef(TypedDict):
    id: str,
    clientToken: NotRequired[str],

DeregisterDeviceRequestRequestTypeDef#

# DeregisterDeviceRequestRequestTypeDef definition

class DeregisterDeviceRequestRequestTypeDef(TypedDict):
    id: str,
    targetDeviceStatus: NotRequired[TargetDeviceStatusType],  # (1)
    clientToken: NotRequired[str],
  1. See TargetDeviceStatusType

DeviceSummaryTypeDef#

# DeviceSummaryTypeDef definition

class DeviceSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    serialNumber: NotRequired[str],
    name: NotRequired[str],
    model: NotRequired[str],
    environmentId: NotRequired[str],
    status: NotRequired[DeviceStatusType],  # (1)
    currentSoftwareSetId: NotRequired[str],
    desiredSoftwareSetId: NotRequired[str],
    pendingSoftwareSetId: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (2)
    lastConnectedAt: NotRequired[datetime],
    lastPostureAt: NotRequired[datetime],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    arn: NotRequired[str],
  1. See DeviceStatusType
  2. See SoftwareSetUpdateScheduleType

DeviceTypeDef#

# DeviceTypeDef definition

class DeviceTypeDef(TypedDict):
    id: NotRequired[str],
    serialNumber: NotRequired[str],
    name: NotRequired[str],
    model: NotRequired[str],
    environmentId: NotRequired[str],
    status: NotRequired[DeviceStatusType],  # (1)
    currentSoftwareSetId: NotRequired[str],
    currentSoftwareSetVersion: NotRequired[str],
    desiredSoftwareSetId: NotRequired[str],
    pendingSoftwareSetId: NotRequired[str],
    pendingSoftwareSetVersion: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (2)
    softwareSetComplianceStatus: NotRequired[DeviceSoftwareSetComplianceStatusType],  # (3)
    softwareSetUpdateStatus: NotRequired[SoftwareSetUpdateStatusType],  # (4)
    lastConnectedAt: NotRequired[datetime],
    lastPostureAt: NotRequired[datetime],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    arn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See DeviceStatusType
  2. See SoftwareSetUpdateScheduleType
  3. See DeviceSoftwareSetComplianceStatusType
  4. See SoftwareSetUpdateStatusType

MaintenanceWindowOutputTypeDef#

# MaintenanceWindowOutputTypeDef definition

class MaintenanceWindowOutputTypeDef(TypedDict):
    type: NotRequired[MaintenanceWindowTypeType],  # (1)
    startTimeHour: NotRequired[int],
    startTimeMinute: NotRequired[int],
    endTimeHour: NotRequired[int],
    endTimeMinute: NotRequired[int],
    daysOfTheWeek: NotRequired[List[DayOfWeekType]],  # (2)
    applyTimeOf: NotRequired[ApplyTimeOfType],  # (3)
  1. See MaintenanceWindowTypeType
  2. See DayOfWeekType
  3. See ApplyTimeOfType

GetDeviceRequestRequestTypeDef#

# GetDeviceRequestRequestTypeDef definition

class GetDeviceRequestRequestTypeDef(TypedDict):
    id: str,

GetEnvironmentRequestRequestTypeDef#

# GetEnvironmentRequestRequestTypeDef definition

class GetEnvironmentRequestRequestTypeDef(TypedDict):
    id: str,

GetSoftwareSetRequestRequestTypeDef#

# GetSoftwareSetRequestRequestTypeDef definition

class GetSoftwareSetRequestRequestTypeDef(TypedDict):
    id: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDevicesRequestRequestTypeDef#

# ListDevicesRequestRequestTypeDef definition

class ListDevicesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListEnvironmentsRequestRequestTypeDef#

# ListEnvironmentsRequestRequestTypeDef definition

class ListEnvironmentsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListSoftwareSetsRequestRequestTypeDef#

# ListSoftwareSetsRequestRequestTypeDef definition

class ListSoftwareSetsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SoftwareSetSummaryTypeDef#

# SoftwareSetSummaryTypeDef definition

class SoftwareSetSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    version: NotRequired[str],
    releasedAt: NotRequired[datetime],
    supportedUntil: NotRequired[datetime],
    validationStatus: NotRequired[SoftwareSetValidationStatusType],  # (1)
    arn: NotRequired[str],
  1. See SoftwareSetValidationStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MaintenanceWindowExtraOutputTypeDef#

# MaintenanceWindowExtraOutputTypeDef definition

class MaintenanceWindowExtraOutputTypeDef(TypedDict):
    type: NotRequired[MaintenanceWindowTypeType],  # (1)
    startTimeHour: NotRequired[int],
    startTimeMinute: NotRequired[int],
    endTimeHour: NotRequired[int],
    endTimeMinute: NotRequired[int],
    daysOfTheWeek: NotRequired[List[DayOfWeekType]],  # (2)
    applyTimeOf: NotRequired[ApplyTimeOfType],  # (3)
  1. See MaintenanceWindowTypeType
  2. See DayOfWeekType
  3. See ApplyTimeOfType

SoftwareTypeDef#

# SoftwareTypeDef definition

class SoftwareTypeDef(TypedDict):
    name: NotRequired[str],
    version: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateDeviceRequestRequestTypeDef#

# UpdateDeviceRequestRequestTypeDef definition

class UpdateDeviceRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    desiredSoftwareSetId: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (1)
  1. See SoftwareSetUpdateScheduleType

UpdateSoftwareSetRequestRequestTypeDef#

# UpdateSoftwareSetRequestRequestTypeDef definition

class UpdateSoftwareSetRequestRequestTypeDef(TypedDict):
    id: str,
    validationStatus: SoftwareSetValidationStatusType,  # (1)
  1. See SoftwareSetValidationStatusType

CreateEnvironmentRequestRequestTypeDef#

# CreateEnvironmentRequestRequestTypeDef definition

class CreateEnvironmentRequestRequestTypeDef(TypedDict):
    desktopArn: str,
    name: NotRequired[str],
    desktopEndpoint: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (1)
    maintenanceWindow: NotRequired[MaintenanceWindowTypeDef],  # (2)
    softwareSetUpdateMode: NotRequired[SoftwareSetUpdateModeType],  # (3)
    desiredSoftwareSetId: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    deviceCreationTags: NotRequired[Mapping[str, str]],
  1. See SoftwareSetUpdateScheduleType
  2. See MaintenanceWindowTypeDef
  3. See SoftwareSetUpdateModeType

UpdateEnvironmentRequestRequestTypeDef#

# UpdateEnvironmentRequestRequestTypeDef definition

class UpdateEnvironmentRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    desktopArn: NotRequired[str],
    desktopEndpoint: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (1)
    maintenanceWindow: NotRequired[MaintenanceWindowTypeDef],  # (2)
    softwareSetUpdateMode: NotRequired[SoftwareSetUpdateModeType],  # (3)
    desiredSoftwareSetId: NotRequired[str],
    deviceCreationTags: NotRequired[Mapping[str, str]],
  1. See SoftwareSetUpdateScheduleType
  2. See MaintenanceWindowTypeDef
  3. See SoftwareSetUpdateModeType

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDevicesResponseTypeDef#

# ListDevicesResponseTypeDef definition

class ListDevicesResponseTypeDef(TypedDict):
    devices: List[DeviceSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceSummaryTypeDef
  2. See ResponseMetadataTypeDef

UpdateDeviceResponseTypeDef#

# UpdateDeviceResponseTypeDef definition

class UpdateDeviceResponseTypeDef(TypedDict):
    device: DeviceSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetDeviceResponseTypeDef#

# GetDeviceResponseTypeDef definition

class GetDeviceResponseTypeDef(TypedDict):
    device: DeviceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceTypeDef
  2. See ResponseMetadataTypeDef

EnvironmentSummaryTypeDef#

# EnvironmentSummaryTypeDef definition

class EnvironmentSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    desktopArn: NotRequired[str],
    desktopEndpoint: NotRequired[str],
    desktopType: NotRequired[DesktopTypeType],  # (1)
    activationCode: NotRequired[str],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (2)
    maintenanceWindow: NotRequired[MaintenanceWindowOutputTypeDef],  # (3)
    softwareSetUpdateMode: NotRequired[SoftwareSetUpdateModeType],  # (4)
    desiredSoftwareSetId: NotRequired[str],
    pendingSoftwareSetId: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    arn: NotRequired[str],
  1. See DesktopTypeType
  2. See SoftwareSetUpdateScheduleType
  3. See MaintenanceWindowOutputTypeDef
  4. See SoftwareSetUpdateModeType

EnvironmentTypeDef#

# EnvironmentTypeDef definition

class EnvironmentTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    desktopArn: NotRequired[str],
    desktopEndpoint: NotRequired[str],
    desktopType: NotRequired[DesktopTypeType],  # (1)
    activationCode: NotRequired[str],
    registeredDevicesCount: NotRequired[int],
    softwareSetUpdateSchedule: NotRequired[SoftwareSetUpdateScheduleType],  # (2)
    maintenanceWindow: NotRequired[MaintenanceWindowOutputTypeDef],  # (3)
    softwareSetUpdateMode: NotRequired[SoftwareSetUpdateModeType],  # (4)
    desiredSoftwareSetId: NotRequired[str],
    pendingSoftwareSetId: NotRequired[str],
    pendingSoftwareSetVersion: NotRequired[str],
    softwareSetComplianceStatus: NotRequired[EnvironmentSoftwareSetComplianceStatusType],  # (5)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    arn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    deviceCreationTags: NotRequired[Dict[str, str]],
  1. See DesktopTypeType
  2. See SoftwareSetUpdateScheduleType
  3. See MaintenanceWindowOutputTypeDef
  4. See SoftwareSetUpdateModeType
  5. See EnvironmentSoftwareSetComplianceStatusType

ListDevicesRequestListDevicesPaginateTypeDef#

# ListDevicesRequestListDevicesPaginateTypeDef definition

class ListDevicesRequestListDevicesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListEnvironmentsRequestListEnvironmentsPaginateTypeDef#

# ListEnvironmentsRequestListEnvironmentsPaginateTypeDef definition

class ListEnvironmentsRequestListEnvironmentsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSoftwareSetsRequestListSoftwareSetsPaginateTypeDef