Skip to content

Type definitions#

Index > WorkSpaces > Type definitions

Auto-generated documentation for WorkSpaces type annotations stubs module types-aiobotocore-workspaces.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AccountModificationTypeDef#

# AccountModificationTypeDef definition

class AccountModificationTypeDef(TypedDict):
    ModificationState: NotRequired[DedicatedTenancyModificationStateEnumType],  # (1)
    DedicatedTenancySupport: NotRequired[DedicatedTenancySupportResultEnumType],  # (2)
    DedicatedTenancyManagementCidrRange: NotRequired[str],
    StartTime: NotRequired[datetime],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
  1. See DedicatedTenancyModificationStateEnumType
  2. See DedicatedTenancySupportResultEnumType

AssociateConnectionAliasRequestRequestTypeDef#

# AssociateConnectionAliasRequestRequestTypeDef definition

class AssociateConnectionAliasRequestRequestTypeDef(TypedDict):
    AliasId: str,
    ResourceId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AssociateIpGroupsRequestRequestTypeDef#

# AssociateIpGroupsRequestRequestTypeDef definition

class AssociateIpGroupsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    GroupIds: Sequence[str],

IpRuleItemTypeDef#

# IpRuleItemTypeDef definition

class IpRuleItemTypeDef(TypedDict):
    ipRule: NotRequired[str],
    ruleDesc: NotRequired[str],

CertificateBasedAuthPropertiesTypeDef#

# CertificateBasedAuthPropertiesTypeDef definition

class CertificateBasedAuthPropertiesTypeDef(TypedDict):
    Status: NotRequired[CertificateBasedAuthStatusEnumType],  # (1)
    CertificateAuthorityArn: NotRequired[str],
  1. See CertificateBasedAuthStatusEnumType

ClientPropertiesTypeDef#

# ClientPropertiesTypeDef definition

class ClientPropertiesTypeDef(TypedDict):
    ReconnectEnabled: NotRequired[ReconnectEnumType],  # (1)
    LogUploadEnabled: NotRequired[LogUploadEnumType],  # (2)
  1. See ReconnectEnumType
  2. See LogUploadEnumType

ComputeTypeTypeDef#

# ComputeTypeTypeDef definition

class ComputeTypeTypeDef(TypedDict):
    Name: NotRequired[ComputeType],  # (1)
  1. See ComputeType

ConnectClientAddInTypeDef#

# ConnectClientAddInTypeDef definition

class ConnectClientAddInTypeDef(TypedDict):
    AddInId: NotRequired[str],
    ResourceId: NotRequired[str],
    Name: NotRequired[str],
    URL: NotRequired[str],

ConnectionAliasAssociationTypeDef#

# ConnectionAliasAssociationTypeDef definition

class ConnectionAliasAssociationTypeDef(TypedDict):
    AssociationStatus: NotRequired[AssociationStatusType],  # (1)
    AssociatedAccountId: NotRequired[str],
    ResourceId: NotRequired[str],
    ConnectionIdentifier: NotRequired[str],
  1. See AssociationStatusType

ConnectionAliasPermissionTypeDef#

# ConnectionAliasPermissionTypeDef definition

class ConnectionAliasPermissionTypeDef(TypedDict):
    SharedAccountId: str,
    AllowAssociation: bool,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

CreateConnectClientAddInRequestRequestTypeDef#

# CreateConnectClientAddInRequestRequestTypeDef definition

class CreateConnectClientAddInRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    Name: str,
    URL: str,

PendingCreateStandbyWorkspacesRequestTypeDef#

# PendingCreateStandbyWorkspacesRequestTypeDef definition

class PendingCreateStandbyWorkspacesRequestTypeDef(TypedDict):
    UserName: NotRequired[str],
    DirectoryId: NotRequired[str],
    State: NotRequired[WorkspaceStateType],  # (1)
    WorkspaceId: NotRequired[str],
  1. See WorkspaceStateType

RootStorageTypeDef#

# RootStorageTypeDef definition

class RootStorageTypeDef(TypedDict):
    Capacity: NotRequired[str],

UserStorageTypeDef#

# UserStorageTypeDef definition

class UserStorageTypeDef(TypedDict):
    Capacity: NotRequired[str],

OperatingSystemTypeDef#

# OperatingSystemTypeDef definition

class OperatingSystemTypeDef(TypedDict):
    Type: NotRequired[OperatingSystemTypeType],  # (1)
  1. See OperatingSystemTypeType

DefaultClientBrandingAttributesTypeDef#

# DefaultClientBrandingAttributesTypeDef definition

class DefaultClientBrandingAttributesTypeDef(TypedDict):
    LogoUrl: NotRequired[str],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Dict[str, str]],

DefaultWorkspaceCreationPropertiesTypeDef#

# DefaultWorkspaceCreationPropertiesTypeDef definition

class DefaultWorkspaceCreationPropertiesTypeDef(TypedDict):
    EnableWorkDocs: NotRequired[bool],
    EnableInternetAccess: NotRequired[bool],
    DefaultOu: NotRequired[str],
    CustomSecurityGroupId: NotRequired[str],
    UserEnabledAsLocalAdministrator: NotRequired[bool],
    EnableMaintenanceMode: NotRequired[bool],

DeleteClientBrandingRequestRequestTypeDef#

# DeleteClientBrandingRequestRequestTypeDef definition

class DeleteClientBrandingRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    Platforms: Sequence[ClientDeviceTypeType],  # (1)
  1. See ClientDeviceTypeType

DeleteConnectClientAddInRequestRequestTypeDef#

# DeleteConnectClientAddInRequestRequestTypeDef definition

class DeleteConnectClientAddInRequestRequestTypeDef(TypedDict):
    AddInId: str,
    ResourceId: str,

DeleteConnectionAliasRequestRequestTypeDef#

# DeleteConnectionAliasRequestRequestTypeDef definition

class DeleteConnectionAliasRequestRequestTypeDef(TypedDict):
    AliasId: str,

DeleteIpGroupRequestRequestTypeDef#

# DeleteIpGroupRequestRequestTypeDef definition

class DeleteIpGroupRequestRequestTypeDef(TypedDict):
    GroupId: str,

DeleteTagsRequestRequestTypeDef#

# DeleteTagsRequestRequestTypeDef definition

class DeleteTagsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagKeys: Sequence[str],

DeleteWorkspaceBundleRequestRequestTypeDef#

# DeleteWorkspaceBundleRequestRequestTypeDef definition

class DeleteWorkspaceBundleRequestRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],

DeleteWorkspaceImageRequestRequestTypeDef#

# DeleteWorkspaceImageRequestRequestTypeDef definition

class DeleteWorkspaceImageRequestRequestTypeDef(TypedDict):
    ImageId: str,

DeregisterWorkspaceDirectoryRequestRequestTypeDef#

# DeregisterWorkspaceDirectoryRequestRequestTypeDef definition

class DeregisterWorkspaceDirectoryRequestRequestTypeDef(TypedDict):
    DirectoryId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeAccountModificationsRequestRequestTypeDef#

# DescribeAccountModificationsRequestRequestTypeDef definition

class DescribeAccountModificationsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

DescribeClientBrandingRequestRequestTypeDef#

# DescribeClientBrandingRequestRequestTypeDef definition

class DescribeClientBrandingRequestRequestTypeDef(TypedDict):
    ResourceId: str,

IosClientBrandingAttributesTypeDef#

# IosClientBrandingAttributesTypeDef definition

class IosClientBrandingAttributesTypeDef(TypedDict):
    LogoUrl: NotRequired[str],
    Logo2xUrl: NotRequired[str],
    Logo3xUrl: NotRequired[str],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Dict[str, str]],

DescribeClientPropertiesRequestRequestTypeDef#

# DescribeClientPropertiesRequestRequestTypeDef definition

class DescribeClientPropertiesRequestRequestTypeDef(TypedDict):
    ResourceIds: Sequence[str],

DescribeConnectClientAddInsRequestRequestTypeDef#

# DescribeConnectClientAddInsRequestRequestTypeDef definition

class DescribeConnectClientAddInsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeConnectionAliasPermissionsRequestRequestTypeDef#

# DescribeConnectionAliasPermissionsRequestRequestTypeDef definition

class DescribeConnectionAliasPermissionsRequestRequestTypeDef(TypedDict):
    AliasId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeConnectionAliasesRequestRequestTypeDef#

# DescribeConnectionAliasesRequestRequestTypeDef definition

class DescribeConnectionAliasesRequestRequestTypeDef(TypedDict):
    AliasIds: NotRequired[Sequence[str]],
    ResourceId: NotRequired[str],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeIpGroupsRequestRequestTypeDef#

# DescribeIpGroupsRequestRequestTypeDef definition

class DescribeIpGroupsRequestRequestTypeDef(TypedDict):
    GroupIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeTagsRequestRequestTypeDef#

# DescribeTagsRequestRequestTypeDef definition

class DescribeTagsRequestRequestTypeDef(TypedDict):
    ResourceId: str,

DescribeWorkspaceBundlesRequestRequestTypeDef#

# DescribeWorkspaceBundlesRequestRequestTypeDef definition

class DescribeWorkspaceBundlesRequestRequestTypeDef(TypedDict):
    BundleIds: NotRequired[Sequence[str]],
    Owner: NotRequired[str],
    NextToken: NotRequired[str],

DescribeWorkspaceDirectoriesRequestRequestTypeDef#

# DescribeWorkspaceDirectoriesRequestRequestTypeDef definition

class DescribeWorkspaceDirectoriesRequestRequestTypeDef(TypedDict):
    DirectoryIds: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeWorkspaceImagePermissionsRequestRequestTypeDef#

# DescribeWorkspaceImagePermissionsRequestRequestTypeDef definition

class DescribeWorkspaceImagePermissionsRequestRequestTypeDef(TypedDict):
    ImageId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ImagePermissionTypeDef#

# ImagePermissionTypeDef definition

class ImagePermissionTypeDef(TypedDict):
    SharedAccountId: NotRequired[str],

DescribeWorkspaceImagesRequestRequestTypeDef#

# DescribeWorkspaceImagesRequestRequestTypeDef definition

class DescribeWorkspaceImagesRequestRequestTypeDef(TypedDict):
    ImageIds: NotRequired[Sequence[str]],
    ImageType: NotRequired[ImageTypeType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ImageTypeType

DescribeWorkspaceSnapshotsRequestRequestTypeDef#

# DescribeWorkspaceSnapshotsRequestRequestTypeDef definition

class DescribeWorkspaceSnapshotsRequestRequestTypeDef(TypedDict):
    WorkspaceId: str,

SnapshotTypeDef#

# SnapshotTypeDef definition

class SnapshotTypeDef(TypedDict):
    SnapshotTime: NotRequired[datetime],

DescribeWorkspacesConnectionStatusRequestRequestTypeDef#

# DescribeWorkspacesConnectionStatusRequestRequestTypeDef definition

class DescribeWorkspacesConnectionStatusRequestRequestTypeDef(TypedDict):
    WorkspaceIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],

WorkspaceConnectionStatusTypeDef#

# WorkspaceConnectionStatusTypeDef definition

class WorkspaceConnectionStatusTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],
    ConnectionState: NotRequired[ConnectionStateType],  # (1)
    ConnectionStateCheckTimestamp: NotRequired[datetime],
    LastKnownUserConnectionTimestamp: NotRequired[datetime],
  1. See ConnectionStateType

DescribeWorkspacesRequestRequestTypeDef#

# DescribeWorkspacesRequestRequestTypeDef definition

class DescribeWorkspacesRequestRequestTypeDef(TypedDict):
    WorkspaceIds: NotRequired[Sequence[str]],
    DirectoryId: NotRequired[str],
    UserName: NotRequired[str],
    BundleId: NotRequired[str],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DisassociateConnectionAliasRequestRequestTypeDef#

# DisassociateConnectionAliasRequestRequestTypeDef definition

class DisassociateConnectionAliasRequestRequestTypeDef(TypedDict):
    AliasId: str,

DisassociateIpGroupsRequestRequestTypeDef#

# DisassociateIpGroupsRequestRequestTypeDef definition

class DisassociateIpGroupsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    GroupIds: Sequence[str],

FailedWorkspaceChangeRequestTypeDef#

# FailedWorkspaceChangeRequestTypeDef definition

class FailedWorkspaceChangeRequestTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

ListAvailableManagementCidrRangesRequestRequestTypeDef#

# ListAvailableManagementCidrRangesRequestRequestTypeDef definition

class ListAvailableManagementCidrRangesRequestRequestTypeDef(TypedDict):
    ManagementCidrRangeConstraint: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MigrateWorkspaceRequestRequestTypeDef#

# MigrateWorkspaceRequestRequestTypeDef definition

class MigrateWorkspaceRequestRequestTypeDef(TypedDict):
    SourceWorkspaceId: str,
    BundleId: str,

ModificationStateTypeDef#

# ModificationStateTypeDef definition

class ModificationStateTypeDef(TypedDict):
    Resource: NotRequired[ModificationResourceEnumType],  # (1)
    State: NotRequired[ModificationStateEnumType],  # (2)
  1. See ModificationResourceEnumType
  2. See ModificationStateEnumType

ModifyAccountRequestRequestTypeDef#

# ModifyAccountRequestRequestTypeDef definition

class ModifyAccountRequestRequestTypeDef(TypedDict):
    DedicatedTenancySupport: NotRequired[DedicatedTenancySupportEnumType],  # (1)
    DedicatedTenancyManagementCidrRange: NotRequired[str],
  1. See DedicatedTenancySupportEnumType

SamlPropertiesTypeDef#

# SamlPropertiesTypeDef definition

class SamlPropertiesTypeDef(TypedDict):
    Status: NotRequired[SamlStatusEnumType],  # (1)
    UserAccessUrl: NotRequired[str],
    RelayStateParameterName: NotRequired[str],
  1. See SamlStatusEnumType

SelfservicePermissionsTypeDef#

# SelfservicePermissionsTypeDef definition

class SelfservicePermissionsTypeDef(TypedDict):
    RestartWorkspace: NotRequired[ReconnectEnumType],  # (1)
    IncreaseVolumeSize: NotRequired[ReconnectEnumType],  # (1)
    ChangeComputeType: NotRequired[ReconnectEnumType],  # (1)
    SwitchRunningMode: NotRequired[ReconnectEnumType],  # (1)
    RebuildWorkspace: NotRequired[ReconnectEnumType],  # (1)
  1. See ReconnectEnumType
  2. See ReconnectEnumType
  3. See ReconnectEnumType
  4. See ReconnectEnumType
  5. See ReconnectEnumType

WorkspaceAccessPropertiesTypeDef#

# WorkspaceAccessPropertiesTypeDef definition

class WorkspaceAccessPropertiesTypeDef(TypedDict):
    DeviceTypeWindows: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeOsx: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeWeb: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeIos: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeAndroid: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeChromeOs: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeZeroClient: NotRequired[AccessPropertyValueType],  # (1)
    DeviceTypeLinux: NotRequired[AccessPropertyValueType],  # (1)
  1. See AccessPropertyValueType
  2. See AccessPropertyValueType
  3. See AccessPropertyValueType
  4. See AccessPropertyValueType
  5. See AccessPropertyValueType
  6. See AccessPropertyValueType
  7. See AccessPropertyValueType
  8. See AccessPropertyValueType

WorkspaceCreationPropertiesTypeDef#

# WorkspaceCreationPropertiesTypeDef definition

class WorkspaceCreationPropertiesTypeDef(TypedDict):
    EnableWorkDocs: NotRequired[bool],
    EnableInternetAccess: NotRequired[bool],
    DefaultOu: NotRequired[str],
    CustomSecurityGroupId: NotRequired[str],
    UserEnabledAsLocalAdministrator: NotRequired[bool],
    EnableMaintenanceMode: NotRequired[bool],

WorkspacePropertiesTypeDef#

# WorkspacePropertiesTypeDef definition

class WorkspacePropertiesTypeDef(TypedDict):
    RunningMode: NotRequired[RunningModeType],  # (1)
    RunningModeAutoStopTimeoutInMinutes: NotRequired[int],
    RootVolumeSizeGib: NotRequired[int],
    UserVolumeSizeGib: NotRequired[int],
    ComputeTypeName: NotRequired[ComputeType],  # (2)
    Protocols: NotRequired[Sequence[ProtocolType]],  # (3)
  1. See RunningModeType
  2. See ComputeType
  3. See ProtocolType

ModifyWorkspaceStateRequestRequestTypeDef#

# ModifyWorkspaceStateRequestRequestTypeDef definition

class ModifyWorkspaceStateRequestRequestTypeDef(TypedDict):
    WorkspaceId: str,
    WorkspaceState: TargetWorkspaceStateType,  # (1)
  1. See TargetWorkspaceStateType

RebootRequestTypeDef#

# RebootRequestTypeDef definition

class RebootRequestTypeDef(TypedDict):
    WorkspaceId: str,

RebuildRequestTypeDef#

# RebuildRequestTypeDef definition

class RebuildRequestTypeDef(TypedDict):
    WorkspaceId: str,

RelatedWorkspacePropertiesTypeDef#

# RelatedWorkspacePropertiesTypeDef definition

class RelatedWorkspacePropertiesTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],
    Region: NotRequired[str],
    State: NotRequired[WorkspaceStateType],  # (1)
    Type: NotRequired[StandbyWorkspaceRelationshipTypeType],  # (2)
  1. See WorkspaceStateType
  2. See StandbyWorkspaceRelationshipTypeType

RestoreWorkspaceRequestRequestTypeDef#

# RestoreWorkspaceRequestRequestTypeDef definition

class RestoreWorkspaceRequestRequestTypeDef(TypedDict):
    WorkspaceId: str,

RevokeIpRulesRequestRequestTypeDef#

# RevokeIpRulesRequestRequestTypeDef definition

class RevokeIpRulesRequestRequestTypeDef(TypedDict):
    GroupId: str,
    UserRules: Sequence[str],

StartRequestTypeDef#

# StartRequestTypeDef definition

class StartRequestTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],

StopRequestTypeDef#

# StopRequestTypeDef definition

class StopRequestTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],

TerminateRequestTypeDef#

# TerminateRequestTypeDef definition

class TerminateRequestTypeDef(TypedDict):
    WorkspaceId: str,

UpdateConnectClientAddInRequestRequestTypeDef#

# UpdateConnectClientAddInRequestRequestTypeDef definition

class UpdateConnectClientAddInRequestRequestTypeDef(TypedDict):
    AddInId: str,
    ResourceId: str,
    Name: NotRequired[str],
    URL: NotRequired[str],

UpdateResultTypeDef#

# UpdateResultTypeDef definition

class UpdateResultTypeDef(TypedDict):
    UpdateAvailable: NotRequired[bool],
    Description: NotRequired[str],

UpdateWorkspaceBundleRequestRequestTypeDef#

# UpdateWorkspaceBundleRequestRequestTypeDef definition

class UpdateWorkspaceBundleRequestRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],
    ImageId: NotRequired[str],

UpdateWorkspaceImagePermissionRequestRequestTypeDef#

# UpdateWorkspaceImagePermissionRequestRequestTypeDef definition

class UpdateWorkspaceImagePermissionRequestRequestTypeDef(TypedDict):
    ImageId: str,
    AllowCopyImage: bool,
    SharedAccountId: str,

AssociateConnectionAliasResultTypeDef#

# AssociateConnectionAliasResultTypeDef definition

class AssociateConnectionAliasResultTypeDef(TypedDict):
    ConnectionIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CopyWorkspaceImageResultTypeDef#

# CopyWorkspaceImageResultTypeDef definition

class CopyWorkspaceImageResultTypeDef(TypedDict):
    ImageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConnectClientAddInResultTypeDef#

# CreateConnectClientAddInResultTypeDef definition

class CreateConnectClientAddInResultTypeDef(TypedDict):
    AddInId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConnectionAliasResultTypeDef#

# CreateConnectionAliasResultTypeDef definition

class CreateConnectionAliasResultTypeDef(TypedDict):
    AliasId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIpGroupResultTypeDef#

# CreateIpGroupResultTypeDef definition

class CreateIpGroupResultTypeDef(TypedDict):
    GroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUpdatedWorkspaceImageResultTypeDef#

# CreateUpdatedWorkspaceImageResultTypeDef definition

class CreateUpdatedWorkspaceImageResultTypeDef(TypedDict):
    ImageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountModificationsResultTypeDef#

# DescribeAccountModificationsResultTypeDef definition

class DescribeAccountModificationsResultTypeDef(TypedDict):
    AccountModifications: List[AccountModificationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountModificationTypeDef
  2. See ResponseMetadataTypeDef

DescribeAccountResultTypeDef#

# DescribeAccountResultTypeDef definition

class DescribeAccountResultTypeDef(TypedDict):
    DedicatedTenancySupport: DedicatedTenancySupportResultEnumType,  # (1)
    DedicatedTenancyManagementCidrRange: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DedicatedTenancySupportResultEnumType
  2. See ResponseMetadataTypeDef

ImportWorkspaceImageResultTypeDef#

# ImportWorkspaceImageResultTypeDef definition

class ImportWorkspaceImageResultTypeDef(TypedDict):
    ImageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAvailableManagementCidrRangesResultTypeDef#

# ListAvailableManagementCidrRangesResultTypeDef definition

class ListAvailableManagementCidrRangesResultTypeDef(TypedDict):
    ManagementCidrRanges: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MigrateWorkspaceResultTypeDef#

# MigrateWorkspaceResultTypeDef definition

class MigrateWorkspaceResultTypeDef(TypedDict):
    SourceWorkspaceId: str,
    TargetWorkspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AuthorizeIpRulesRequestRequestTypeDef#

# AuthorizeIpRulesRequestRequestTypeDef definition

class AuthorizeIpRulesRequestRequestTypeDef(TypedDict):
    GroupId: str,
    UserRules: Sequence[IpRuleItemTypeDef],  # (1)
  1. See IpRuleItemTypeDef

UpdateRulesOfIpGroupRequestRequestTypeDef#

# UpdateRulesOfIpGroupRequestRequestTypeDef definition

class UpdateRulesOfIpGroupRequestRequestTypeDef(TypedDict):
    GroupId: str,
    UserRules: Sequence[IpRuleItemTypeDef],  # (1)
  1. See IpRuleItemTypeDef

WorkspacesIpGroupTypeDef#

# WorkspacesIpGroupTypeDef definition

class WorkspacesIpGroupTypeDef(TypedDict):
    groupId: NotRequired[str],
    groupName: NotRequired[str],
    groupDesc: NotRequired[str],
    userRules: NotRequired[List[IpRuleItemTypeDef]],  # (1)
  1. See IpRuleItemTypeDef

DefaultImportClientBrandingAttributesTypeDef#

# DefaultImportClientBrandingAttributesTypeDef definition

class DefaultImportClientBrandingAttributesTypeDef(TypedDict):
    Logo: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Mapping[str, str]],

IosImportClientBrandingAttributesTypeDef#

# IosImportClientBrandingAttributesTypeDef definition

class IosImportClientBrandingAttributesTypeDef(TypedDict):
    Logo: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    Logo2x: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    Logo3x: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Mapping[str, str]],

ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef#

# ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef definition

class ModifyCertificateBasedAuthPropertiesRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    CertificateBasedAuthProperties: NotRequired[CertificateBasedAuthPropertiesTypeDef],  # (1)
    PropertiesToDelete: NotRequired[Sequence[DeletableCertificateBasedAuthPropertyType]],  # (2)
  1. See CertificateBasedAuthPropertiesTypeDef
  2. See DeletableCertificateBasedAuthPropertyType

ClientPropertiesResultTypeDef#

# ClientPropertiesResultTypeDef definition

class ClientPropertiesResultTypeDef(TypedDict):
    ResourceId: NotRequired[str],
    ClientProperties: NotRequired[ClientPropertiesTypeDef],  # (1)
  1. See ClientPropertiesTypeDef

ModifyClientPropertiesRequestRequestTypeDef#

# ModifyClientPropertiesRequestRequestTypeDef definition

class ModifyClientPropertiesRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    ClientProperties: ClientPropertiesTypeDef,  # (1)
  1. See ClientPropertiesTypeDef

DescribeConnectClientAddInsResultTypeDef#

# DescribeConnectClientAddInsResultTypeDef definition

class DescribeConnectClientAddInsResultTypeDef(TypedDict):
    AddIns: List[ConnectClientAddInTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectClientAddInTypeDef
  2. See ResponseMetadataTypeDef

ConnectionAliasTypeDef#

# ConnectionAliasTypeDef definition

class ConnectionAliasTypeDef(TypedDict):
    ConnectionString: NotRequired[str],
    AliasId: NotRequired[str],
    State: NotRequired[ConnectionAliasStateType],  # (1)
    OwnerAccountId: NotRequired[str],
    Associations: NotRequired[List[ConnectionAliasAssociationTypeDef]],  # (2)
  1. See ConnectionAliasStateType
  2. See ConnectionAliasAssociationTypeDef

DescribeConnectionAliasPermissionsResultTypeDef#

# DescribeConnectionAliasPermissionsResultTypeDef definition

class DescribeConnectionAliasPermissionsResultTypeDef(TypedDict):
    AliasId: str,
    ConnectionAliasPermissions: List[ConnectionAliasPermissionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionAliasPermissionTypeDef
  2. See ResponseMetadataTypeDef

UpdateConnectionAliasPermissionRequestRequestTypeDef#

# UpdateConnectionAliasPermissionRequestRequestTypeDef definition

class UpdateConnectionAliasPermissionRequestRequestTypeDef(TypedDict):
    AliasId: str,
    ConnectionAliasPermission: ConnectionAliasPermissionTypeDef,  # (1)
  1. See ConnectionAliasPermissionTypeDef

CopyWorkspaceImageRequestRequestTypeDef#

# CopyWorkspaceImageRequestRequestTypeDef definition

class CopyWorkspaceImageRequestRequestTypeDef(TypedDict):
    Name: str,
    SourceImageId: str,
    SourceRegion: str,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateConnectionAliasRequestRequestTypeDef#

# CreateConnectionAliasRequestRequestTypeDef definition

class CreateConnectionAliasRequestRequestTypeDef(TypedDict):
    ConnectionString: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateIpGroupRequestRequestTypeDef#

# CreateIpGroupRequestRequestTypeDef definition

class CreateIpGroupRequestRequestTypeDef(TypedDict):
    GroupName: str,
    GroupDesc: NotRequired[str],
    UserRules: NotRequired[Sequence[IpRuleItemTypeDef]],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See IpRuleItemTypeDef
  2. See TagTypeDef

CreateTagsRequestRequestTypeDef#

# CreateTagsRequestRequestTypeDef definition

class CreateTagsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateUpdatedWorkspaceImageRequestRequestTypeDef#

# CreateUpdatedWorkspaceImageRequestRequestTypeDef definition

class CreateUpdatedWorkspaceImageRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: str,
    SourceImageId: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateWorkspaceImageRequestRequestTypeDef#

# CreateWorkspaceImageRequestRequestTypeDef definition

class CreateWorkspaceImageRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: str,
    WorkspaceId: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

DescribeTagsResultTypeDef#

# DescribeTagsResultTypeDef definition

class DescribeTagsResultTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

ImportWorkspaceImageRequestRequestTypeDef#

# ImportWorkspaceImageRequestRequestTypeDef definition

class ImportWorkspaceImageRequestRequestTypeDef(TypedDict):
    Ec2ImageId: str,
    IngestionProcess: WorkspaceImageIngestionProcessType,  # (1)
    ImageName: str,
    ImageDescription: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Applications: NotRequired[Sequence[ApplicationType]],  # (3)
  1. See WorkspaceImageIngestionProcessType
  2. See TagTypeDef
  3. See ApplicationType

RegisterWorkspaceDirectoryRequestRequestTypeDef#

# RegisterWorkspaceDirectoryRequestRequestTypeDef definition

class RegisterWorkspaceDirectoryRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    EnableWorkDocs: bool,
    SubnetIds: NotRequired[Sequence[str]],
    EnableSelfService: NotRequired[bool],
    Tenancy: NotRequired[TenancyType],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See TenancyType
  2. See TagTypeDef

StandbyWorkspaceTypeDef#

# StandbyWorkspaceTypeDef definition

class StandbyWorkspaceTypeDef(TypedDict):
    PrimaryWorkspaceId: str,
    DirectoryId: str,
    VolumeEncryptionKey: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateWorkspaceBundleRequestRequestTypeDef#

# CreateWorkspaceBundleRequestRequestTypeDef definition

class CreateWorkspaceBundleRequestRequestTypeDef(TypedDict):
    BundleName: str,
    BundleDescription: str,
    ImageId: str,
    ComputeType: ComputeTypeTypeDef,  # (1)
    UserStorage: UserStorageTypeDef,  # (2)
    RootStorage: NotRequired[RootStorageTypeDef],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See ComputeTypeTypeDef
  2. See UserStorageTypeDef
  3. See RootStorageTypeDef
  4. See TagTypeDef

WorkspaceBundleTypeDef#

# WorkspaceBundleTypeDef definition

class WorkspaceBundleTypeDef(TypedDict):
    BundleId: NotRequired[str],
    Name: NotRequired[str],
    Owner: NotRequired[str],
    Description: NotRequired[str],
    ImageId: NotRequired[str],
    RootStorage: NotRequired[RootStorageTypeDef],  # (1)
    UserStorage: NotRequired[UserStorageTypeDef],  # (2)
    ComputeType: NotRequired[ComputeTypeTypeDef],  # (3)
    LastUpdatedTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    State: NotRequired[WorkspaceBundleStateType],  # (4)
    BundleType: NotRequired[BundleTypeType],  # (5)
  1. See RootStorageTypeDef
  2. See UserStorageTypeDef
  3. See ComputeTypeTypeDef
  4. See WorkspaceBundleStateType
  5. See BundleTypeType

CreateWorkspaceImageResultTypeDef#

# CreateWorkspaceImageResultTypeDef definition

class CreateWorkspaceImageResultTypeDef(TypedDict):
    ImageId: str,
    Name: str,
    Description: str,
    OperatingSystem: OperatingSystemTypeDef,  # (1)
    State: WorkspaceImageStateType,  # (2)
    RequiredTenancy: WorkspaceImageRequiredTenancyType,  # (3)
    Created: datetime,
    OwnerAccountId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See OperatingSystemTypeDef
  2. See WorkspaceImageStateType
  3. See WorkspaceImageRequiredTenancyType
  4. See ResponseMetadataTypeDef

DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef#

# DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef definition

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

DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef#

# DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef definition

class DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef(TypedDict):
    GroupIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef#

# DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef definition

class DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef(TypedDict):
    BundleIds: NotRequired[Sequence[str]],
    Owner: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef#

# DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef definition

class DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef(TypedDict):
    DirectoryIds: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef#

# DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef definition

class DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef(TypedDict):
    ImageIds: NotRequired[Sequence[str]],
    ImageType: NotRequired[ImageTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ImageTypeType
  2. See PaginatorConfigTypeDef

DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef#

# DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef definition

class DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef(TypedDict):
    WorkspaceIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef#

# DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef definition

class DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef(TypedDict):
    WorkspaceIds: NotRequired[Sequence[str]],
    DirectoryId: NotRequired[str],
    UserName: NotRequired[str],
    BundleId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef#

# ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef definition

class ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef(TypedDict):
    ManagementCidrRangeConstraint: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeClientBrandingResultTypeDef#

# DescribeClientBrandingResultTypeDef definition

class DescribeClientBrandingResultTypeDef(TypedDict):
    DeviceTypeWindows: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeOsx: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeAndroid: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeIos: IosClientBrandingAttributesTypeDef,  # (4)
    DeviceTypeLinux: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeWeb: DefaultClientBrandingAttributesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See DefaultClientBrandingAttributesTypeDef
  2. See DefaultClientBrandingAttributesTypeDef
  3. See DefaultClientBrandingAttributesTypeDef
  4. See IosClientBrandingAttributesTypeDef
  5. See DefaultClientBrandingAttributesTypeDef
  6. See DefaultClientBrandingAttributesTypeDef
  7. See ResponseMetadataTypeDef

ImportClientBrandingResultTypeDef#

# ImportClientBrandingResultTypeDef definition

class ImportClientBrandingResultTypeDef(TypedDict):
    DeviceTypeWindows: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeOsx: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeAndroid: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeIos: IosClientBrandingAttributesTypeDef,  # (4)
    DeviceTypeLinux: DefaultClientBrandingAttributesTypeDef,  # (1)
    DeviceTypeWeb: DefaultClientBrandingAttributesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See DefaultClientBrandingAttributesTypeDef
  2. See DefaultClientBrandingAttributesTypeDef
  3. See DefaultClientBrandingAttributesTypeDef
  4. See IosClientBrandingAttributesTypeDef
  5. See DefaultClientBrandingAttributesTypeDef
  6. See DefaultClientBrandingAttributesTypeDef
  7. See ResponseMetadataTypeDef

DescribeWorkspaceImagePermissionsResultTypeDef#

# DescribeWorkspaceImagePermissionsResultTypeDef definition

class DescribeWorkspaceImagePermissionsResultTypeDef(TypedDict):
    ImageId: str,
    ImagePermissions: List[ImagePermissionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImagePermissionTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceSnapshotsResultTypeDef#

# DescribeWorkspaceSnapshotsResultTypeDef definition

class DescribeWorkspaceSnapshotsResultTypeDef(TypedDict):
    RebuildSnapshots: List[SnapshotTypeDef],  # (1)
    RestoreSnapshots: List[SnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SnapshotTypeDef
  2. See SnapshotTypeDef
  3. See ResponseMetadataTypeDef

DescribeWorkspacesConnectionStatusResultTypeDef#

# DescribeWorkspacesConnectionStatusResultTypeDef definition

class DescribeWorkspacesConnectionStatusResultTypeDef(TypedDict):
    WorkspacesConnectionStatus: List[WorkspaceConnectionStatusTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceConnectionStatusTypeDef
  2. See ResponseMetadataTypeDef

RebootWorkspacesResultTypeDef#

# RebootWorkspacesResultTypeDef definition

class RebootWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedWorkspaceChangeRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedWorkspaceChangeRequestTypeDef
  2. See ResponseMetadataTypeDef

RebuildWorkspacesResultTypeDef#

# RebuildWorkspacesResultTypeDef definition

class RebuildWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedWorkspaceChangeRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedWorkspaceChangeRequestTypeDef
  2. See ResponseMetadataTypeDef

StartWorkspacesResultTypeDef#

# StartWorkspacesResultTypeDef definition

class StartWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedWorkspaceChangeRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedWorkspaceChangeRequestTypeDef
  2. See ResponseMetadataTypeDef

StopWorkspacesResultTypeDef#

# StopWorkspacesResultTypeDef definition

class StopWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedWorkspaceChangeRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedWorkspaceChangeRequestTypeDef
  2. See ResponseMetadataTypeDef

TerminateWorkspacesResultTypeDef#

# TerminateWorkspacesResultTypeDef definition

class TerminateWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedWorkspaceChangeRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedWorkspaceChangeRequestTypeDef
  2. See ResponseMetadataTypeDef

ModifySamlPropertiesRequestRequestTypeDef#

# ModifySamlPropertiesRequestRequestTypeDef definition

class ModifySamlPropertiesRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    SamlProperties: NotRequired[SamlPropertiesTypeDef],  # (1)
    PropertiesToDelete: NotRequired[Sequence[DeletableSamlPropertyType]],  # (2)
  1. See SamlPropertiesTypeDef
  2. See DeletableSamlPropertyType

ModifySelfservicePermissionsRequestRequestTypeDef#

# ModifySelfservicePermissionsRequestRequestTypeDef definition

class ModifySelfservicePermissionsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    SelfservicePermissions: SelfservicePermissionsTypeDef,  # (1)
  1. See SelfservicePermissionsTypeDef

ModifyWorkspaceAccessPropertiesRequestRequestTypeDef#

# ModifyWorkspaceAccessPropertiesRequestRequestTypeDef definition

class ModifyWorkspaceAccessPropertiesRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    WorkspaceAccessProperties: WorkspaceAccessPropertiesTypeDef,  # (1)
  1. See WorkspaceAccessPropertiesTypeDef

WorkspaceDirectoryTypeDef#

# WorkspaceDirectoryTypeDef definition

class WorkspaceDirectoryTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    Alias: NotRequired[str],
    DirectoryName: NotRequired[str],
    RegistrationCode: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    DnsIpAddresses: NotRequired[List[str]],
    CustomerUserName: NotRequired[str],
    IamRoleId: NotRequired[str],
    DirectoryType: NotRequired[WorkspaceDirectoryTypeType],  # (1)
    WorkspaceSecurityGroupId: NotRequired[str],
    State: NotRequired[WorkspaceDirectoryStateType],  # (2)
    WorkspaceCreationProperties: NotRequired[DefaultWorkspaceCreationPropertiesTypeDef],  # (3)
    ipGroupIds: NotRequired[List[str]],
    WorkspaceAccessProperties: NotRequired[WorkspaceAccessPropertiesTypeDef],  # (4)
    Tenancy: NotRequired[TenancyType],  # (5)
    SelfservicePermissions: NotRequired[SelfservicePermissionsTypeDef],  # (6)
    SamlProperties: NotRequired[SamlPropertiesTypeDef],  # (7)
    CertificateBasedAuthProperties: NotRequired[CertificateBasedAuthPropertiesTypeDef],  # (8)
  1. See WorkspaceDirectoryTypeType
  2. See WorkspaceDirectoryStateType
  3. See DefaultWorkspaceCreationPropertiesTypeDef
  4. See WorkspaceAccessPropertiesTypeDef
  5. See TenancyType
  6. See SelfservicePermissionsTypeDef
  7. See SamlPropertiesTypeDef
  8. See CertificateBasedAuthPropertiesTypeDef

ModifyWorkspaceCreationPropertiesRequestRequestTypeDef#

# ModifyWorkspaceCreationPropertiesRequestRequestTypeDef definition

class ModifyWorkspaceCreationPropertiesRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    WorkspaceCreationProperties: WorkspaceCreationPropertiesTypeDef,  # (1)
  1. See WorkspaceCreationPropertiesTypeDef

ModifyWorkspacePropertiesRequestRequestTypeDef#

# ModifyWorkspacePropertiesRequestRequestTypeDef definition

class ModifyWorkspacePropertiesRequestRequestTypeDef(TypedDict):
    WorkspaceId: str,
    WorkspaceProperties: WorkspacePropertiesTypeDef,  # (1)
  1. See WorkspacePropertiesTypeDef

WorkspaceRequestTypeDef#

# WorkspaceRequestTypeDef definition

class WorkspaceRequestTypeDef(TypedDict):
    DirectoryId: str,
    UserName: str,
    BundleId: str,
    VolumeEncryptionKey: NotRequired[str],
    UserVolumeEncryptionEnabled: NotRequired[bool],
    RootVolumeEncryptionEnabled: NotRequired[bool],
    WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See WorkspacePropertiesTypeDef
  2. See TagTypeDef

RebootWorkspacesRequestRequestTypeDef#

# RebootWorkspacesRequestRequestTypeDef definition

class RebootWorkspacesRequestRequestTypeDef(TypedDict):
    RebootWorkspaceRequests: Sequence[RebootRequestTypeDef],  # (1)
  1. See RebootRequestTypeDef

RebuildWorkspacesRequestRequestTypeDef#

# RebuildWorkspacesRequestRequestTypeDef definition

class RebuildWorkspacesRequestRequestTypeDef(TypedDict):
    RebuildWorkspaceRequests: Sequence[RebuildRequestTypeDef],  # (1)
  1. See RebuildRequestTypeDef

WorkspaceTypeDef#

# WorkspaceTypeDef definition

class WorkspaceTypeDef(TypedDict):
    WorkspaceId: NotRequired[str],
    DirectoryId: NotRequired[str],
    UserName: NotRequired[str],
    IpAddress: NotRequired[str],
    State: NotRequired[WorkspaceStateType],  # (1)
    BundleId: NotRequired[str],
    SubnetId: NotRequired[str],
    ErrorMessage: NotRequired[str],
    ErrorCode: NotRequired[str],
    ComputerName: NotRequired[str],
    VolumeEncryptionKey: NotRequired[str],
    UserVolumeEncryptionEnabled: NotRequired[bool],
    RootVolumeEncryptionEnabled: NotRequired[bool],
    WorkspaceProperties: NotRequired[WorkspacePropertiesTypeDef],  # (2)
    ModificationStates: NotRequired[List[ModificationStateTypeDef]],  # (3)
    RelatedWorkspaces: NotRequired[List[RelatedWorkspacePropertiesTypeDef]],  # (4)
  1. See WorkspaceStateType
  2. See WorkspacePropertiesTypeDef
  3. See ModificationStateTypeDef
  4. See RelatedWorkspacePropertiesTypeDef

StartWorkspacesRequestRequestTypeDef#

# StartWorkspacesRequestRequestTypeDef definition

class StartWorkspacesRequestRequestTypeDef(TypedDict):
    StartWorkspaceRequests: Sequence[StartRequestTypeDef],  # (1)
  1. See StartRequestTypeDef

StopWorkspacesRequestRequestTypeDef#

# StopWorkspacesRequestRequestTypeDef definition

class StopWorkspacesRequestRequestTypeDef(TypedDict):
    StopWorkspaceRequests: Sequence[StopRequestTypeDef],  # (1)
  1. See StopRequestTypeDef

TerminateWorkspacesRequestRequestTypeDef#

# TerminateWorkspacesRequestRequestTypeDef definition

class TerminateWorkspacesRequestRequestTypeDef(TypedDict):
    TerminateWorkspaceRequests: Sequence[TerminateRequestTypeDef],  # (1)
  1. See TerminateRequestTypeDef

WorkspaceImageTypeDef#

# WorkspaceImageTypeDef definition

class WorkspaceImageTypeDef(TypedDict):
    ImageId: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    OperatingSystem: NotRequired[OperatingSystemTypeDef],  # (1)
    State: NotRequired[WorkspaceImageStateType],  # (2)
    RequiredTenancy: NotRequired[WorkspaceImageRequiredTenancyType],  # (3)
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    Created: NotRequired[datetime],
    OwnerAccountId: NotRequired[str],
    Updates: NotRequired[UpdateResultTypeDef],  # (4)
  1. See OperatingSystemTypeDef
  2. See WorkspaceImageStateType
  3. See WorkspaceImageRequiredTenancyType
  4. See UpdateResultTypeDef

DescribeIpGroupsResultTypeDef#

# DescribeIpGroupsResultTypeDef definition

class DescribeIpGroupsResultTypeDef(TypedDict):
    Result: List[WorkspacesIpGroupTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspacesIpGroupTypeDef
  2. See ResponseMetadataTypeDef

ImportClientBrandingRequestRequestTypeDef#

# ImportClientBrandingRequestRequestTypeDef definition

class ImportClientBrandingRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    DeviceTypeWindows: NotRequired[DefaultImportClientBrandingAttributesTypeDef],  # (1)
    DeviceTypeOsx: NotRequired[DefaultImportClientBrandingAttributesTypeDef],  # (1)
    DeviceTypeAndroid: NotRequired[DefaultImportClientBrandingAttributesTypeDef],  # (1)
    DeviceTypeIos: NotRequired[IosImportClientBrandingAttributesTypeDef],  # (4)
    DeviceTypeLinux: NotRequired[DefaultImportClientBrandingAttributesTypeDef],  # (1)
    DeviceTypeWeb: NotRequired[DefaultImportClientBrandingAttributesTypeDef],  # (1)
  1. See DefaultImportClientBrandingAttributesTypeDef
  2. See DefaultImportClientBrandingAttributesTypeDef
  3. See DefaultImportClientBrandingAttributesTypeDef
  4. See IosImportClientBrandingAttributesTypeDef
  5. See DefaultImportClientBrandingAttributesTypeDef
  6. See DefaultImportClientBrandingAttributesTypeDef

DescribeClientPropertiesResultTypeDef#

# DescribeClientPropertiesResultTypeDef definition

class DescribeClientPropertiesResultTypeDef(TypedDict):
    ClientPropertiesList: List[ClientPropertiesResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClientPropertiesResultTypeDef
  2. See ResponseMetadataTypeDef

DescribeConnectionAliasesResultTypeDef#

# DescribeConnectionAliasesResultTypeDef definition

class DescribeConnectionAliasesResultTypeDef(TypedDict):
    ConnectionAliases: List[ConnectionAliasTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionAliasTypeDef
  2. See ResponseMetadataTypeDef

CreateStandbyWorkspacesRequestRequestTypeDef#

# CreateStandbyWorkspacesRequestRequestTypeDef definition

class CreateStandbyWorkspacesRequestRequestTypeDef(TypedDict):
    PrimaryRegion: str,
    StandbyWorkspaces: Sequence[StandbyWorkspaceTypeDef],  # (1)
  1. See StandbyWorkspaceTypeDef

FailedCreateStandbyWorkspacesRequestTypeDef#

# FailedCreateStandbyWorkspacesRequestTypeDef definition

class FailedCreateStandbyWorkspacesRequestTypeDef(TypedDict):
    StandbyWorkspaceRequest: NotRequired[StandbyWorkspaceTypeDef],  # (1)
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
  1. See StandbyWorkspaceTypeDef

CreateWorkspaceBundleResultTypeDef#

# CreateWorkspaceBundleResultTypeDef definition

class CreateWorkspaceBundleResultTypeDef(TypedDict):
    WorkspaceBundle: WorkspaceBundleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceBundleTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceBundlesResultTypeDef#

# DescribeWorkspaceBundlesResultTypeDef definition

class DescribeWorkspaceBundlesResultTypeDef(TypedDict):
    Bundles: List[WorkspaceBundleTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceBundleTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceDirectoriesResultTypeDef#

# DescribeWorkspaceDirectoriesResultTypeDef definition

class DescribeWorkspaceDirectoriesResultTypeDef(TypedDict):
    Directories: List[WorkspaceDirectoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDirectoryTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkspacesRequestRequestTypeDef#

# CreateWorkspacesRequestRequestTypeDef definition

class CreateWorkspacesRequestRequestTypeDef(TypedDict):
    Workspaces: Sequence[WorkspaceRequestTypeDef],  # (1)
  1. See WorkspaceRequestTypeDef

FailedCreateWorkspaceRequestTypeDef#

# FailedCreateWorkspaceRequestTypeDef definition

class FailedCreateWorkspaceRequestTypeDef(TypedDict):
    WorkspaceRequest: NotRequired[WorkspaceRequestTypeDef],  # (1)
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
  1. See WorkspaceRequestTypeDef

DescribeWorkspacesResultTypeDef#

# DescribeWorkspacesResultTypeDef definition

class DescribeWorkspacesResultTypeDef(TypedDict):
    Workspaces: List[WorkspaceTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceImagesResultTypeDef#

# DescribeWorkspaceImagesResultTypeDef definition

class DescribeWorkspaceImagesResultTypeDef(TypedDict):
    Images: List[WorkspaceImageTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceImageTypeDef
  2. See ResponseMetadataTypeDef

CreateStandbyWorkspacesResultTypeDef#

# CreateStandbyWorkspacesResultTypeDef definition

class CreateStandbyWorkspacesResultTypeDef(TypedDict):
    FailedStandbyRequests: List[FailedCreateStandbyWorkspacesRequestTypeDef],  # (1)
    PendingStandbyRequests: List[PendingCreateStandbyWorkspacesRequestTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedCreateStandbyWorkspacesRequestTypeDef
  2. See PendingCreateStandbyWorkspacesRequestTypeDef
  3. See ResponseMetadataTypeDef

CreateWorkspacesResultTypeDef#

# CreateWorkspacesResultTypeDef definition

class CreateWorkspacesResultTypeDef(TypedDict):
    FailedRequests: List[FailedCreateWorkspaceRequestTypeDef],  # (1)
    PendingRequests: List[WorkspaceTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedCreateWorkspaceRequestTypeDef
  2. See WorkspaceTypeDef
  3. See ResponseMetadataTypeDef