Skip to content

Type definitions#

Index > WorkSpaces > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_workspaces.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

StandbyWorkspaceUnionTypeDef#

# StandbyWorkspaceUnionTypeDef Union usage example

from mypy_boto3_workspaces.type_defs import StandbyWorkspaceUnionTypeDef


def get_value() -> StandbyWorkspaceUnionTypeDef:
    return ...


# StandbyWorkspaceUnionTypeDef definition

StandbyWorkspaceUnionTypeDef = Union[
    StandbyWorkspaceTypeDef,  # (1)
    StandbyWorkspaceOutputTypeDef,  # (2)
]
  1. See StandbyWorkspaceTypeDef
  2. See StandbyWorkspaceOutputTypeDef

WorkspacePropertiesUnionTypeDef#

# WorkspacePropertiesUnionTypeDef Union usage example

from mypy_boto3_workspaces.type_defs import WorkspacePropertiesUnionTypeDef


def get_value() -> WorkspacePropertiesUnionTypeDef:
    return ...


# WorkspacePropertiesUnionTypeDef definition

WorkspacePropertiesUnionTypeDef = Union[
    WorkspacePropertiesTypeDef,  # (1)
    WorkspacePropertiesOutputTypeDef,  # (2)
]
  1. See WorkspacePropertiesTypeDef
  2. See WorkspacePropertiesOutputTypeDef

StreamingPropertiesUnionTypeDef#

# StreamingPropertiesUnionTypeDef Union usage example

from mypy_boto3_workspaces.type_defs import StreamingPropertiesUnionTypeDef


def get_value() -> StreamingPropertiesUnionTypeDef:
    return ...


# StreamingPropertiesUnionTypeDef definition

StreamingPropertiesUnionTypeDef = Union[
    StreamingPropertiesTypeDef,  # (1)
    StreamingPropertiesOutputTypeDef,  # (2)
]
  1. See StreamingPropertiesTypeDef
  2. See StreamingPropertiesOutputTypeDef

WorkspaceRequestUnionTypeDef#

# WorkspaceRequestUnionTypeDef Union usage example

from mypy_boto3_workspaces.type_defs import WorkspaceRequestUnionTypeDef


def get_value() -> WorkspaceRequestUnionTypeDef:
    return ...


# WorkspaceRequestUnionTypeDef definition

WorkspaceRequestUnionTypeDef = Union[
    WorkspaceRequestTypeDef,  # (1)
    WorkspaceRequestOutputTypeDef,  # (2)
]
  1. See WorkspaceRequestTypeDef
  2. See WorkspaceRequestOutputTypeDef

AcceptAccountLinkInvitationRequestTypeDef#

# AcceptAccountLinkInvitationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AcceptAccountLinkInvitationRequestTypeDef


def get_value() -> AcceptAccountLinkInvitationRequestTypeDef:
    return {
        "LinkId": ...,
    }


# AcceptAccountLinkInvitationRequestTypeDef definition

class AcceptAccountLinkInvitationRequestTypeDef(TypedDict):
    LinkId: str,
    ClientToken: NotRequired[str],

AccountLinkTypeDef#

# AccountLinkTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AccountLinkTypeDef


def get_value() -> AccountLinkTypeDef:
    return {
        "AccountLinkId": ...,
    }


# AccountLinkTypeDef definition

class AccountLinkTypeDef(TypedDict):
    AccountLinkId: NotRequired[str],
    AccountLinkStatus: NotRequired[AccountLinkStatusEnumType],  # (1)
    SourceAccountId: NotRequired[str],
    TargetAccountId: NotRequired[str],
  1. See AccountLinkStatusEnumType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

AccountModificationTypeDef#

# AccountModificationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AccountModificationTypeDef


def get_value() -> AccountModificationTypeDef:
    return {
        "ModificationState": ...,
    }


# AccountModificationTypeDef definition

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

ActiveDirectoryConfigTypeDef#

# ActiveDirectoryConfigTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ActiveDirectoryConfigTypeDef


def get_value() -> ActiveDirectoryConfigTypeDef:
    return {
        "DomainName": ...,
    }


# ActiveDirectoryConfigTypeDef definition

class ActiveDirectoryConfigTypeDef(TypedDict):
    DomainName: str,
    ServiceAccountSecretArn: str,

AssociationStateReasonTypeDef#

# AssociationStateReasonTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociationStateReasonTypeDef


def get_value() -> AssociationStateReasonTypeDef:
    return {
        "ErrorCode": ...,
    }


# AssociationStateReasonTypeDef definition

class AssociationStateReasonTypeDef(TypedDict):
    ErrorCode: NotRequired[AssociationErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See AssociationErrorCodeType

ApplicationSettingsRequestTypeDef#

# ApplicationSettingsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ApplicationSettingsRequestTypeDef


def get_value() -> ApplicationSettingsRequestTypeDef:
    return {
        "Status": ...,
    }


# ApplicationSettingsRequestTypeDef definition

class ApplicationSettingsRequestTypeDef(TypedDict):
    Status: ApplicationSettingsStatusEnumType,  # (1)
    SettingsGroup: NotRequired[str],
  1. See ApplicationSettingsStatusEnumType

ApplicationSettingsResponseTypeDef#

# ApplicationSettingsResponseTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ApplicationSettingsResponseTypeDef


def get_value() -> ApplicationSettingsResponseTypeDef:
    return {
        "Status": ...,
    }


# ApplicationSettingsResponseTypeDef definition

class ApplicationSettingsResponseTypeDef(TypedDict):
    Status: ApplicationSettingsStatusEnumType,  # (1)
    SettingsGroup: NotRequired[str],
    S3BucketName: NotRequired[str],
  1. See ApplicationSettingsStatusEnumType

AssociateConnectionAliasRequestTypeDef#

# AssociateConnectionAliasRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociateConnectionAliasRequestTypeDef


def get_value() -> AssociateConnectionAliasRequestTypeDef:
    return {
        "AliasId": ...,
    }


# AssociateConnectionAliasRequestTypeDef definition

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

AssociateIpGroupsRequestTypeDef#

# AssociateIpGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociateIpGroupsRequestTypeDef


def get_value() -> AssociateIpGroupsRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# AssociateIpGroupsRequestTypeDef definition

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

AssociateWorkspaceApplicationRequestTypeDef#

# AssociateWorkspaceApplicationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociateWorkspaceApplicationRequestTypeDef


def get_value() -> AssociateWorkspaceApplicationRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# AssociateWorkspaceApplicationRequestTypeDef definition

class AssociateWorkspaceApplicationRequestTypeDef(TypedDict):
    WorkspaceId: str,
    ApplicationId: str,

IpRuleItemTypeDef#

# IpRuleItemTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import IpRuleItemTypeDef


def get_value() -> IpRuleItemTypeDef:
    return {
        "ipRule": ...,
    }


# IpRuleItemTypeDef definition

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

CapacityStatusTypeDef#

# CapacityStatusTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CapacityStatusTypeDef


def get_value() -> CapacityStatusTypeDef:
    return {
        "AvailableUserSessions": ...,
    }


# CapacityStatusTypeDef definition

class CapacityStatusTypeDef(TypedDict):
    AvailableUserSessions: int,
    DesiredUserSessions: int,
    ActualUserSessions: int,
    ActiveUserSessions: int,

CapacityTypeDef#

# CapacityTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CapacityTypeDef


def get_value() -> CapacityTypeDef:
    return {
        "DesiredUserSessions": ...,
    }


# CapacityTypeDef definition

class CapacityTypeDef(TypedDict):
    DesiredUserSessions: int,

CertificateBasedAuthPropertiesTypeDef#

# CertificateBasedAuthPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CertificateBasedAuthPropertiesTypeDef


def get_value() -> CertificateBasedAuthPropertiesTypeDef:
    return {
        "Status": ...,
    }


# CertificateBasedAuthPropertiesTypeDef definition

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

ClientPropertiesTypeDef#

# ClientPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ClientPropertiesTypeDef


def get_value() -> ClientPropertiesTypeDef:
    return {
        "ReconnectEnabled": ...,
    }


# ClientPropertiesTypeDef definition

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

ComputeTypeTypeDef#

# ComputeTypeTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ComputeTypeTypeDef


def get_value() -> ComputeTypeTypeDef:
    return {
        "Name": ...,
    }


# ComputeTypeTypeDef definition

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

ConnectClientAddInTypeDef#

# ConnectClientAddInTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ConnectClientAddInTypeDef


def get_value() -> ConnectClientAddInTypeDef:
    return {
        "AddInId": ...,
    }


# ConnectClientAddInTypeDef definition

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

ConnectionAliasAssociationTypeDef#

# ConnectionAliasAssociationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ConnectionAliasAssociationTypeDef


def get_value() -> ConnectionAliasAssociationTypeDef:
    return {
        "AssociationStatus": ...,
    }


# ConnectionAliasAssociationTypeDef definition

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

ConnectionAliasPermissionTypeDef#

# ConnectionAliasPermissionTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ConnectionAliasPermissionTypeDef


def get_value() -> ConnectionAliasPermissionTypeDef:
    return {
        "SharedAccountId": ...,
    }


# ConnectionAliasPermissionTypeDef definition

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

TagTypeDef#

# TagTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

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

CreateAccountLinkInvitationRequestTypeDef#

# CreateAccountLinkInvitationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateAccountLinkInvitationRequestTypeDef


def get_value() -> CreateAccountLinkInvitationRequestTypeDef:
    return {
        "TargetAccountId": ...,
    }


# CreateAccountLinkInvitationRequestTypeDef definition

class CreateAccountLinkInvitationRequestTypeDef(TypedDict):
    TargetAccountId: str,
    ClientToken: NotRequired[str],

CreateConnectClientAddInRequestTypeDef#

# CreateConnectClientAddInRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateConnectClientAddInRequestTypeDef


def get_value() -> CreateConnectClientAddInRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# CreateConnectClientAddInRequestTypeDef definition

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

PendingCreateStandbyWorkspacesRequestTypeDef#

# PendingCreateStandbyWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import PendingCreateStandbyWorkspacesRequestTypeDef


def get_value() -> PendingCreateStandbyWorkspacesRequestTypeDef:
    return {
        "UserName": ...,
    }


# PendingCreateStandbyWorkspacesRequestTypeDef definition

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

RootStorageTypeDef#

# RootStorageTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RootStorageTypeDef


def get_value() -> RootStorageTypeDef:
    return {
        "Capacity": ...,
    }


# RootStorageTypeDef definition

class RootStorageTypeDef(TypedDict):
    Capacity: str,

UserStorageTypeDef#

# UserStorageTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UserStorageTypeDef


def get_value() -> UserStorageTypeDef:
    return {
        "Capacity": ...,
    }


# UserStorageTypeDef definition

class UserStorageTypeDef(TypedDict):
    Capacity: str,

OperatingSystemTypeDef#

# OperatingSystemTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import OperatingSystemTypeDef


def get_value() -> OperatingSystemTypeDef:
    return {
        "Type": ...,
    }


# OperatingSystemTypeDef definition

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

TimeoutSettingsTypeDef#

# TimeoutSettingsTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TimeoutSettingsTypeDef


def get_value() -> TimeoutSettingsTypeDef:
    return {
        "DisconnectTimeoutInSeconds": ...,
    }


# TimeoutSettingsTypeDef definition

class TimeoutSettingsTypeDef(TypedDict):
    DisconnectTimeoutInSeconds: NotRequired[int],
    IdleDisconnectTimeoutInSeconds: NotRequired[int],
    MaxUserDurationInSeconds: NotRequired[int],

DataReplicationSettingsTypeDef#

# DataReplicationSettingsTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DataReplicationSettingsTypeDef


def get_value() -> DataReplicationSettingsTypeDef:
    return {
        "DataReplication": ...,
    }


# DataReplicationSettingsTypeDef definition

class DataReplicationSettingsTypeDef(TypedDict):
    DataReplication: NotRequired[DataReplicationType],  # (1)
    RecoverySnapshotTime: NotRequired[datetime.datetime],
  1. See DataReplicationType

DefaultClientBrandingAttributesTypeDef#

# DefaultClientBrandingAttributesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DefaultClientBrandingAttributesTypeDef


def get_value() -> DefaultClientBrandingAttributesTypeDef:
    return {
        "LogoUrl": ...,
    }


# DefaultClientBrandingAttributesTypeDef definition

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

DefaultWorkspaceCreationPropertiesTypeDef#

# DefaultWorkspaceCreationPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DefaultWorkspaceCreationPropertiesTypeDef


def get_value() -> DefaultWorkspaceCreationPropertiesTypeDef:
    return {
        "EnableWorkDocs": ...,
    }


# DefaultWorkspaceCreationPropertiesTypeDef definition

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

DeleteAccountLinkInvitationRequestTypeDef#

# DeleteAccountLinkInvitationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteAccountLinkInvitationRequestTypeDef


def get_value() -> DeleteAccountLinkInvitationRequestTypeDef:
    return {
        "LinkId": ...,
    }


# DeleteAccountLinkInvitationRequestTypeDef definition

class DeleteAccountLinkInvitationRequestTypeDef(TypedDict):
    LinkId: str,
    ClientToken: NotRequired[str],

DeleteClientBrandingRequestTypeDef#

# DeleteClientBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteClientBrandingRequestTypeDef


def get_value() -> DeleteClientBrandingRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DeleteClientBrandingRequestTypeDef definition

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

DeleteConnectClientAddInRequestTypeDef#

# DeleteConnectClientAddInRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteConnectClientAddInRequestTypeDef


def get_value() -> DeleteConnectClientAddInRequestTypeDef:
    return {
        "AddInId": ...,
    }


# DeleteConnectClientAddInRequestTypeDef definition

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

DeleteConnectionAliasRequestTypeDef#

# DeleteConnectionAliasRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteConnectionAliasRequestTypeDef


def get_value() -> DeleteConnectionAliasRequestTypeDef:
    return {
        "AliasId": ...,
    }


# DeleteConnectionAliasRequestTypeDef definition

class DeleteConnectionAliasRequestTypeDef(TypedDict):
    AliasId: str,

DeleteIpGroupRequestTypeDef#

# DeleteIpGroupRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteIpGroupRequestTypeDef


def get_value() -> DeleteIpGroupRequestTypeDef:
    return {
        "GroupId": ...,
    }


# DeleteIpGroupRequestTypeDef definition

class DeleteIpGroupRequestTypeDef(TypedDict):
    GroupId: str,

DeleteTagsRequestTypeDef#

# DeleteTagsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteTagsRequestTypeDef


def get_value() -> DeleteTagsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DeleteTagsRequestTypeDef definition

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

DeleteWorkspaceBundleRequestTypeDef#

# DeleteWorkspaceBundleRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteWorkspaceBundleRequestTypeDef


def get_value() -> DeleteWorkspaceBundleRequestTypeDef:
    return {
        "BundleId": ...,
    }


# DeleteWorkspaceBundleRequestTypeDef definition

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

DeleteWorkspaceImageRequestTypeDef#

# DeleteWorkspaceImageRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteWorkspaceImageRequestTypeDef


def get_value() -> DeleteWorkspaceImageRequestTypeDef:
    return {
        "ImageId": ...,
    }


# DeleteWorkspaceImageRequestTypeDef definition

class DeleteWorkspaceImageRequestTypeDef(TypedDict):
    ImageId: str,

DeployWorkspaceApplicationsRequestTypeDef#

# DeployWorkspaceApplicationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeployWorkspaceApplicationsRequestTypeDef


def get_value() -> DeployWorkspaceApplicationsRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# DeployWorkspaceApplicationsRequestTypeDef definition

class DeployWorkspaceApplicationsRequestTypeDef(TypedDict):
    WorkspaceId: str,
    Force: NotRequired[bool],

DeregisterWorkspaceDirectoryRequestTypeDef#

# DeregisterWorkspaceDirectoryRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeregisterWorkspaceDirectoryRequestTypeDef


def get_value() -> DeregisterWorkspaceDirectoryRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# DeregisterWorkspaceDirectoryRequestTypeDef definition

class DeregisterWorkspaceDirectoryRequestTypeDef(TypedDict):
    DirectoryId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

DescribeAccountModificationsRequestTypeDef#

# DescribeAccountModificationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsRequestTypeDef


def get_value() -> DescribeAccountModificationsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# DescribeAccountModificationsRequestTypeDef definition

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

DescribeApplicationAssociationsRequestTypeDef#

# DescribeApplicationAssociationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeApplicationAssociationsRequestTypeDef


def get_value() -> DescribeApplicationAssociationsRequestTypeDef:
    return {
        "ApplicationId": ...,
    }


# DescribeApplicationAssociationsRequestTypeDef definition

class DescribeApplicationAssociationsRequestTypeDef(TypedDict):
    ApplicationId: str,
    AssociatedResourceTypes: Sequence[ApplicationAssociatedResourceTypeType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See Sequence[ApplicationAssociatedResourceTypeType]

DescribeApplicationsRequestTypeDef#

# DescribeApplicationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeApplicationsRequestTypeDef


def get_value() -> DescribeApplicationsRequestTypeDef:
    return {
        "ApplicationIds": ...,
    }


# DescribeApplicationsRequestTypeDef definition

class DescribeApplicationsRequestTypeDef(TypedDict):
    ApplicationIds: NotRequired[Sequence[str]],
    ComputeTypeNames: NotRequired[Sequence[ComputeType]],  # (1)
    LicenseType: NotRequired[WorkSpaceApplicationLicenseTypeType],  # (2)
    OperatingSystemNames: NotRequired[Sequence[OperatingSystemNameType]],  # (3)
    Owner: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See Sequence[ComputeType]
  2. See WorkSpaceApplicationLicenseTypeType
  3. See Sequence[OperatingSystemNameType]

WorkSpaceApplicationTypeDef#

# WorkSpaceApplicationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkSpaceApplicationTypeDef


def get_value() -> WorkSpaceApplicationTypeDef:
    return {
        "ApplicationId": ...,
    }


# WorkSpaceApplicationTypeDef definition

class WorkSpaceApplicationTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    Created: NotRequired[datetime.datetime],
    Description: NotRequired[str],
    LicenseType: NotRequired[WorkSpaceApplicationLicenseTypeType],  # (1)
    Name: NotRequired[str],
    Owner: NotRequired[str],
    State: NotRequired[WorkSpaceApplicationStateType],  # (2)
    SupportedComputeTypeNames: NotRequired[List[ComputeType]],  # (3)
    SupportedOperatingSystemNames: NotRequired[List[OperatingSystemNameType]],  # (4)
  1. See WorkSpaceApplicationLicenseTypeType
  2. See WorkSpaceApplicationStateType
  3. See List[ComputeType]
  4. See List[OperatingSystemNameType]

DescribeBundleAssociationsRequestTypeDef#

# DescribeBundleAssociationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeBundleAssociationsRequestTypeDef


def get_value() -> DescribeBundleAssociationsRequestTypeDef:
    return {
        "BundleId": ...,
    }


# DescribeBundleAssociationsRequestTypeDef definition

class DescribeBundleAssociationsRequestTypeDef(TypedDict):
    BundleId: str,
    AssociatedResourceTypes: Sequence[BundleAssociatedResourceTypeType],  # (1)
  1. See Sequence[Literal['APPLICATION']]

DescribeClientBrandingRequestTypeDef#

# DescribeClientBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeClientBrandingRequestTypeDef


def get_value() -> DescribeClientBrandingRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DescribeClientBrandingRequestTypeDef definition

class DescribeClientBrandingRequestTypeDef(TypedDict):
    ResourceId: str,

IosClientBrandingAttributesTypeDef#

# IosClientBrandingAttributesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import IosClientBrandingAttributesTypeDef


def get_value() -> IosClientBrandingAttributesTypeDef:
    return {
        "LogoUrl": ...,
    }


# 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]],

DescribeClientPropertiesRequestTypeDef#

# DescribeClientPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeClientPropertiesRequestTypeDef


def get_value() -> DescribeClientPropertiesRequestTypeDef:
    return {
        "ResourceIds": ...,
    }


# DescribeClientPropertiesRequestTypeDef definition

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

DescribeConnectClientAddInsRequestTypeDef#

# DescribeConnectClientAddInsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectClientAddInsRequestTypeDef


def get_value() -> DescribeConnectClientAddInsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DescribeConnectClientAddInsRequestTypeDef definition

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

DescribeConnectionAliasPermissionsRequestTypeDef#

# DescribeConnectionAliasPermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasPermissionsRequestTypeDef


def get_value() -> DescribeConnectionAliasPermissionsRequestTypeDef:
    return {
        "AliasId": ...,
    }


# DescribeConnectionAliasPermissionsRequestTypeDef definition

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

DescribeConnectionAliasesRequestTypeDef#

# DescribeConnectionAliasesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasesRequestTypeDef


def get_value() -> DescribeConnectionAliasesRequestTypeDef:
    return {
        "AliasIds": ...,
    }


# DescribeConnectionAliasesRequestTypeDef definition

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

DescribeImageAssociationsRequestTypeDef#

# DescribeImageAssociationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeImageAssociationsRequestTypeDef


def get_value() -> DescribeImageAssociationsRequestTypeDef:
    return {
        "ImageId": ...,
    }


# DescribeImageAssociationsRequestTypeDef definition

class DescribeImageAssociationsRequestTypeDef(TypedDict):
    ImageId: str,
    AssociatedResourceTypes: Sequence[ImageAssociatedResourceTypeType],  # (1)
  1. See Sequence[Literal['APPLICATION']]

DescribeIpGroupsRequestTypeDef#

# DescribeIpGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeIpGroupsRequestTypeDef


def get_value() -> DescribeIpGroupsRequestTypeDef:
    return {
        "GroupIds": ...,
    }


# DescribeIpGroupsRequestTypeDef definition

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

DescribeTagsRequestTypeDef#

# DescribeTagsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeTagsRequestTypeDef


def get_value() -> DescribeTagsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DescribeTagsRequestTypeDef definition

class DescribeTagsRequestTypeDef(TypedDict):
    ResourceId: str,

DescribeWorkspaceAssociationsRequestTypeDef#

# DescribeWorkspaceAssociationsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceAssociationsRequestTypeDef


def get_value() -> DescribeWorkspaceAssociationsRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# DescribeWorkspaceAssociationsRequestTypeDef definition

class DescribeWorkspaceAssociationsRequestTypeDef(TypedDict):
    WorkspaceId: str,
    AssociatedResourceTypes: Sequence[WorkSpaceAssociatedResourceTypeType],  # (1)
  1. See Sequence[Literal['APPLICATION']]

DescribeWorkspaceBundlesRequestTypeDef#

# DescribeWorkspaceBundlesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesRequestTypeDef


def get_value() -> DescribeWorkspaceBundlesRequestTypeDef:
    return {
        "BundleIds": ...,
    }


# DescribeWorkspaceBundlesRequestTypeDef definition

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

DescribeWorkspaceDirectoriesFilterTypeDef#

# DescribeWorkspaceDirectoriesFilterTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesFilterTypeDef


def get_value() -> DescribeWorkspaceDirectoriesFilterTypeDef:
    return {
        "Name": ...,
    }


# DescribeWorkspaceDirectoriesFilterTypeDef definition

class DescribeWorkspaceDirectoriesFilterTypeDef(TypedDict):
    Name: DescribeWorkspaceDirectoriesFilterNameType,  # (1)
    Values: Sequence[str],
  1. See DescribeWorkspaceDirectoriesFilterNameType

DescribeWorkspaceImagePermissionsRequestTypeDef#

# DescribeWorkspaceImagePermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagePermissionsRequestTypeDef


def get_value() -> DescribeWorkspaceImagePermissionsRequestTypeDef:
    return {
        "ImageId": ...,
    }


# DescribeWorkspaceImagePermissionsRequestTypeDef definition

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

ImagePermissionTypeDef#

# ImagePermissionTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImagePermissionTypeDef


def get_value() -> ImagePermissionTypeDef:
    return {
        "SharedAccountId": ...,
    }


# ImagePermissionTypeDef definition

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

DescribeWorkspaceImagesRequestTypeDef#

# DescribeWorkspaceImagesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesRequestTypeDef


def get_value() -> DescribeWorkspaceImagesRequestTypeDef:
    return {
        "ImageIds": ...,
    }


# DescribeWorkspaceImagesRequestTypeDef definition

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

DescribeWorkspaceSnapshotsRequestTypeDef#

# DescribeWorkspaceSnapshotsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceSnapshotsRequestTypeDef


def get_value() -> DescribeWorkspaceSnapshotsRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# DescribeWorkspaceSnapshotsRequestTypeDef definition

class DescribeWorkspaceSnapshotsRequestTypeDef(TypedDict):
    WorkspaceId: str,

SnapshotTypeDef#

# SnapshotTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import SnapshotTypeDef


def get_value() -> SnapshotTypeDef:
    return {
        "SnapshotTime": ...,
    }


# SnapshotTypeDef definition

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

DescribeWorkspacesConnectionStatusRequestTypeDef#

# DescribeWorkspacesConnectionStatusRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusRequestTypeDef


def get_value() -> DescribeWorkspacesConnectionStatusRequestTypeDef:
    return {
        "WorkspaceIds": ...,
    }


# DescribeWorkspacesConnectionStatusRequestTypeDef definition

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

WorkspaceConnectionStatusTypeDef#

# WorkspaceConnectionStatusTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceConnectionStatusTypeDef


def get_value() -> WorkspaceConnectionStatusTypeDef:
    return {
        "WorkspaceId": ...,
    }


# WorkspaceConnectionStatusTypeDef definition

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

DescribeWorkspacesPoolSessionsRequestTypeDef#

# DescribeWorkspacesPoolSessionsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesPoolSessionsRequestTypeDef


def get_value() -> DescribeWorkspacesPoolSessionsRequestTypeDef:
    return {
        "PoolId": ...,
    }


# DescribeWorkspacesPoolSessionsRequestTypeDef definition

class DescribeWorkspacesPoolSessionsRequestTypeDef(TypedDict):
    PoolId: str,
    UserId: NotRequired[str],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeWorkspacesPoolsFilterTypeDef#

# DescribeWorkspacesPoolsFilterTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesPoolsFilterTypeDef


def get_value() -> DescribeWorkspacesPoolsFilterTypeDef:
    return {
        "Name": ...,
    }


# DescribeWorkspacesPoolsFilterTypeDef definition

class DescribeWorkspacesPoolsFilterTypeDef(TypedDict):
    Name: DescribeWorkspacesPoolsFilterNameType,  # (1)
    Values: Sequence[str],
    Operator: DescribeWorkspacesPoolsFilterOperatorType,  # (2)
  1. See DescribeWorkspacesPoolsFilterNameType
  2. See DescribeWorkspacesPoolsFilterOperatorType

DescribeWorkspacesRequestTypeDef#

# DescribeWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesRequestTypeDef


def get_value() -> DescribeWorkspacesRequestTypeDef:
    return {
        "WorkspaceIds": ...,
    }


# DescribeWorkspacesRequestTypeDef definition

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

DisassociateConnectionAliasRequestTypeDef#

# DisassociateConnectionAliasRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DisassociateConnectionAliasRequestTypeDef


def get_value() -> DisassociateConnectionAliasRequestTypeDef:
    return {
        "AliasId": ...,
    }


# DisassociateConnectionAliasRequestTypeDef definition

class DisassociateConnectionAliasRequestTypeDef(TypedDict):
    AliasId: str,

DisassociateIpGroupsRequestTypeDef#

# DisassociateIpGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DisassociateIpGroupsRequestTypeDef


def get_value() -> DisassociateIpGroupsRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# DisassociateIpGroupsRequestTypeDef definition

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

DisassociateWorkspaceApplicationRequestTypeDef#

# DisassociateWorkspaceApplicationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DisassociateWorkspaceApplicationRequestTypeDef


def get_value() -> DisassociateWorkspaceApplicationRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# DisassociateWorkspaceApplicationRequestTypeDef definition

class DisassociateWorkspaceApplicationRequestTypeDef(TypedDict):
    WorkspaceId: str,
    ApplicationId: str,

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ErrorDetailsTypeDef


def get_value() -> ErrorDetailsTypeDef:
    return {
        "ErrorCode": ...,
    }


# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    ErrorCode: NotRequired[WorkspaceImageErrorDetailCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See WorkspaceImageErrorDetailCodeType

FailedWorkspaceChangeRequestTypeDef#

# FailedWorkspaceChangeRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import FailedWorkspaceChangeRequestTypeDef


def get_value() -> FailedWorkspaceChangeRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# FailedWorkspaceChangeRequestTypeDef definition

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

GetAccountLinkRequestTypeDef#

# GetAccountLinkRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import GetAccountLinkRequestTypeDef


def get_value() -> GetAccountLinkRequestTypeDef:
    return {
        "LinkId": ...,
    }


# GetAccountLinkRequestTypeDef definition

class GetAccountLinkRequestTypeDef(TypedDict):
    LinkId: NotRequired[str],
    LinkedAccountId: NotRequired[str],

GlobalAcceleratorForDirectoryTypeDef#

# GlobalAcceleratorForDirectoryTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import GlobalAcceleratorForDirectoryTypeDef


def get_value() -> GlobalAcceleratorForDirectoryTypeDef:
    return {
        "Mode": ...,
    }


# GlobalAcceleratorForDirectoryTypeDef definition

class GlobalAcceleratorForDirectoryTypeDef(TypedDict):
    Mode: AGAModeForDirectoryEnumType,  # (1)
    PreferredProtocol: NotRequired[AGAPreferredProtocolForDirectoryType],  # (2)
  1. See AGAModeForDirectoryEnumType
  2. See AGAPreferredProtocolForDirectoryType

GlobalAcceleratorForWorkSpaceTypeDef#

# GlobalAcceleratorForWorkSpaceTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import GlobalAcceleratorForWorkSpaceTypeDef


def get_value() -> GlobalAcceleratorForWorkSpaceTypeDef:
    return {
        "Mode": ...,
    }


# GlobalAcceleratorForWorkSpaceTypeDef definition

class GlobalAcceleratorForWorkSpaceTypeDef(TypedDict):
    Mode: AGAModeForWorkSpaceEnumType,  # (1)
    PreferredProtocol: NotRequired[AGAPreferredProtocolForWorkSpaceType],  # (2)
  1. See AGAModeForWorkSpaceEnumType
  2. See AGAPreferredProtocolForWorkSpaceType

IDCConfigTypeDef#

# IDCConfigTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import IDCConfigTypeDef


def get_value() -> IDCConfigTypeDef:
    return {
        "InstanceArn": ...,
    }


# IDCConfigTypeDef definition

class IDCConfigTypeDef(TypedDict):
    InstanceArn: NotRequired[str],
    ApplicationArn: NotRequired[str],

ListAccountLinksRequestTypeDef#

# ListAccountLinksRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAccountLinksRequestTypeDef


def get_value() -> ListAccountLinksRequestTypeDef:
    return {
        "LinkStatusFilter": ...,
    }


# ListAccountLinksRequestTypeDef definition

class ListAccountLinksRequestTypeDef(TypedDict):
    LinkStatusFilter: NotRequired[Sequence[AccountLinkStatusEnumType]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See Sequence[AccountLinkStatusEnumType]

ListAvailableManagementCidrRangesRequestTypeDef#

# ListAvailableManagementCidrRangesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesRequestTypeDef


def get_value() -> ListAvailableManagementCidrRangesRequestTypeDef:
    return {
        "ManagementCidrRangeConstraint": ...,
    }


# ListAvailableManagementCidrRangesRequestTypeDef definition

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

MicrosoftEntraConfigTypeDef#

# MicrosoftEntraConfigTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import MicrosoftEntraConfigTypeDef


def get_value() -> MicrosoftEntraConfigTypeDef:
    return {
        "TenantId": ...,
    }


# MicrosoftEntraConfigTypeDef definition

class MicrosoftEntraConfigTypeDef(TypedDict):
    TenantId: NotRequired[str],
    ApplicationConfigSecretArn: NotRequired[str],

MigrateWorkspaceRequestTypeDef#

# MigrateWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import MigrateWorkspaceRequestTypeDef


def get_value() -> MigrateWorkspaceRequestTypeDef:
    return {
        "SourceWorkspaceId": ...,
    }


# MigrateWorkspaceRequestTypeDef definition

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

ModificationStateTypeDef#

# ModificationStateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModificationStateTypeDef


def get_value() -> ModificationStateTypeDef:
    return {
        "Resource": ...,
    }


# ModificationStateTypeDef definition

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

ModifyAccountRequestTypeDef#

# ModifyAccountRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyAccountRequestTypeDef


def get_value() -> ModifyAccountRequestTypeDef:
    return {
        "DedicatedTenancySupport": ...,
    }


# ModifyAccountRequestTypeDef definition

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

ModifyEndpointEncryptionModeRequestTypeDef#

# ModifyEndpointEncryptionModeRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyEndpointEncryptionModeRequestTypeDef


def get_value() -> ModifyEndpointEncryptionModeRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# ModifyEndpointEncryptionModeRequestTypeDef definition

class ModifyEndpointEncryptionModeRequestTypeDef(TypedDict):
    DirectoryId: str,
    EndpointEncryptionMode: EndpointEncryptionModeType,  # (1)
  1. See EndpointEncryptionModeType

SamlPropertiesTypeDef#

# SamlPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import SamlPropertiesTypeDef


def get_value() -> SamlPropertiesTypeDef:
    return {
        "Status": ...,
    }


# SamlPropertiesTypeDef definition

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

SelfservicePermissionsTypeDef#

# SelfservicePermissionsTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import SelfservicePermissionsTypeDef


def get_value() -> SelfservicePermissionsTypeDef:
    return {
        "RestartWorkspace": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceAccessPropertiesTypeDef


def get_value() -> WorkspaceAccessPropertiesTypeDef:
    return {
        "DeviceTypeWindows": ...,
    }


# 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)
    DeviceTypeWorkSpacesThinClient: 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
  9. See AccessPropertyValueType

WorkspaceCreationPropertiesTypeDef#

# WorkspaceCreationPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceCreationPropertiesTypeDef


def get_value() -> WorkspaceCreationPropertiesTypeDef:
    return {
        "EnableWorkDocs": ...,
    }


# WorkspaceCreationPropertiesTypeDef definition

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

ModifyWorkspaceStateRequestTypeDef#

# ModifyWorkspaceStateRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyWorkspaceStateRequestTypeDef


def get_value() -> ModifyWorkspaceStateRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# ModifyWorkspaceStateRequestTypeDef definition

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

NetworkAccessConfigurationTypeDef#

# NetworkAccessConfigurationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import NetworkAccessConfigurationTypeDef


def get_value() -> NetworkAccessConfigurationTypeDef:
    return {
        "EniPrivateIpAddress": ...,
    }


# NetworkAccessConfigurationTypeDef definition

class NetworkAccessConfigurationTypeDef(TypedDict):
    EniPrivateIpAddress: NotRequired[str],
    EniId: NotRequired[str],

RebootRequestTypeDef#

# RebootRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebootRequestTypeDef


def get_value() -> RebootRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# RebootRequestTypeDef definition

class RebootRequestTypeDef(TypedDict):
    WorkspaceId: str,

RebuildRequestTypeDef#

# RebuildRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebuildRequestTypeDef


def get_value() -> RebuildRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# RebuildRequestTypeDef definition

class RebuildRequestTypeDef(TypedDict):
    WorkspaceId: str,

RejectAccountLinkInvitationRequestTypeDef#

# RejectAccountLinkInvitationRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RejectAccountLinkInvitationRequestTypeDef


def get_value() -> RejectAccountLinkInvitationRequestTypeDef:
    return {
        "LinkId": ...,
    }


# RejectAccountLinkInvitationRequestTypeDef definition

class RejectAccountLinkInvitationRequestTypeDef(TypedDict):
    LinkId: str,
    ClientToken: NotRequired[str],

RelatedWorkspacePropertiesTypeDef#

# RelatedWorkspacePropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RelatedWorkspacePropertiesTypeDef


def get_value() -> RelatedWorkspacePropertiesTypeDef:
    return {
        "WorkspaceId": ...,
    }


# 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

RestoreWorkspaceRequestTypeDef#

# RestoreWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RestoreWorkspaceRequestTypeDef


def get_value() -> RestoreWorkspaceRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# RestoreWorkspaceRequestTypeDef definition

class RestoreWorkspaceRequestTypeDef(TypedDict):
    WorkspaceId: str,

RevokeIpRulesRequestTypeDef#

# RevokeIpRulesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RevokeIpRulesRequestTypeDef


def get_value() -> RevokeIpRulesRequestTypeDef:
    return {
        "GroupId": ...,
    }


# RevokeIpRulesRequestTypeDef definition

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

StandbyWorkspacesPropertiesTypeDef#

# StandbyWorkspacesPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StandbyWorkspacesPropertiesTypeDef


def get_value() -> StandbyWorkspacesPropertiesTypeDef:
    return {
        "StandbyWorkspaceId": ...,
    }


# StandbyWorkspacesPropertiesTypeDef definition

class StandbyWorkspacesPropertiesTypeDef(TypedDict):
    StandbyWorkspaceId: NotRequired[str],
    DataReplication: NotRequired[DataReplicationType],  # (1)
    RecoverySnapshotTime: NotRequired[datetime.datetime],
  1. See DataReplicationType

StartRequestTypeDef#

# StartRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StartRequestTypeDef


def get_value() -> StartRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# StartRequestTypeDef definition

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

StartWorkspacesPoolRequestTypeDef#

# StartWorkspacesPoolRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StartWorkspacesPoolRequestTypeDef


def get_value() -> StartWorkspacesPoolRequestTypeDef:
    return {
        "PoolId": ...,
    }


# StartWorkspacesPoolRequestTypeDef definition

class StartWorkspacesPoolRequestTypeDef(TypedDict):
    PoolId: str,

StopRequestTypeDef#

# StopRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StopRequestTypeDef


def get_value() -> StopRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# StopRequestTypeDef definition

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

StopWorkspacesPoolRequestTypeDef#

# StopWorkspacesPoolRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StopWorkspacesPoolRequestTypeDef


def get_value() -> StopWorkspacesPoolRequestTypeDef:
    return {
        "PoolId": ...,
    }


# StopWorkspacesPoolRequestTypeDef definition

class StopWorkspacesPoolRequestTypeDef(TypedDict):
    PoolId: str,

StorageConnectorTypeDef#

# StorageConnectorTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StorageConnectorTypeDef


def get_value() -> StorageConnectorTypeDef:
    return {
        "ConnectorType": ...,
    }


# StorageConnectorTypeDef definition

class StorageConnectorTypeDef(TypedDict):
    ConnectorType: StorageConnectorTypeEnumType,  # (1)
    Status: StorageConnectorStatusEnumType,  # (2)
  1. See StorageConnectorTypeEnumType
  2. See StorageConnectorStatusEnumType

UserSettingTypeDef#

# UserSettingTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UserSettingTypeDef


def get_value() -> UserSettingTypeDef:
    return {
        "Action": ...,
    }


# UserSettingTypeDef definition

class UserSettingTypeDef(TypedDict):
    Action: UserSettingActionEnumType,  # (1)
    Permission: UserSettingPermissionEnumType,  # (2)
    MaximumLength: NotRequired[int],
  1. See UserSettingActionEnumType
  2. See UserSettingPermissionEnumType

TerminateRequestTypeDef#

# TerminateRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TerminateRequestTypeDef


def get_value() -> TerminateRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# TerminateRequestTypeDef definition

class TerminateRequestTypeDef(TypedDict):
    WorkspaceId: str,

TerminateWorkspacesPoolRequestTypeDef#

# TerminateWorkspacesPoolRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TerminateWorkspacesPoolRequestTypeDef


def get_value() -> TerminateWorkspacesPoolRequestTypeDef:
    return {
        "PoolId": ...,
    }


# TerminateWorkspacesPoolRequestTypeDef definition

class TerminateWorkspacesPoolRequestTypeDef(TypedDict):
    PoolId: str,

TerminateWorkspacesPoolSessionRequestTypeDef#

# TerminateWorkspacesPoolSessionRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TerminateWorkspacesPoolSessionRequestTypeDef


def get_value() -> TerminateWorkspacesPoolSessionRequestTypeDef:
    return {
        "SessionId": ...,
    }


# TerminateWorkspacesPoolSessionRequestTypeDef definition

class TerminateWorkspacesPoolSessionRequestTypeDef(TypedDict):
    SessionId: str,

UpdateConnectClientAddInRequestTypeDef#

# UpdateConnectClientAddInRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateConnectClientAddInRequestTypeDef


def get_value() -> UpdateConnectClientAddInRequestTypeDef:
    return {
        "AddInId": ...,
    }


# UpdateConnectClientAddInRequestTypeDef definition

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

UpdateResultTypeDef#

# UpdateResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateResultTypeDef


def get_value() -> UpdateResultTypeDef:
    return {
        "UpdateAvailable": ...,
    }


# UpdateResultTypeDef definition

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

UpdateWorkspaceBundleRequestTypeDef#

# UpdateWorkspaceBundleRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateWorkspaceBundleRequestTypeDef


def get_value() -> UpdateWorkspaceBundleRequestTypeDef:
    return {
        "BundleId": ...,
    }


# UpdateWorkspaceBundleRequestTypeDef definition

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

UpdateWorkspaceImagePermissionRequestTypeDef#

# UpdateWorkspaceImagePermissionRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateWorkspaceImagePermissionRequestTypeDef


def get_value() -> UpdateWorkspaceImagePermissionRequestTypeDef:
    return {
        "ImageId": ...,
    }


# UpdateWorkspaceImagePermissionRequestTypeDef definition

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

WorkspacesPoolErrorTypeDef#

# WorkspacesPoolErrorTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacesPoolErrorTypeDef


def get_value() -> WorkspacesPoolErrorTypeDef:
    return {
        "ErrorCode": ...,
    }


# WorkspacesPoolErrorTypeDef definition

class WorkspacesPoolErrorTypeDef(TypedDict):
    ErrorCode: NotRequired[WorkspacesPoolErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See WorkspacesPoolErrorCodeType

AcceptAccountLinkInvitationResultTypeDef#

# AcceptAccountLinkInvitationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AcceptAccountLinkInvitationResultTypeDef


def get_value() -> AcceptAccountLinkInvitationResultTypeDef:
    return {
        "AccountLink": ...,
    }


# AcceptAccountLinkInvitationResultTypeDef definition

class AcceptAccountLinkInvitationResultTypeDef(TypedDict):
    AccountLink: AccountLinkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLinkTypeDef
  2. See ResponseMetadataTypeDef

AssociateConnectionAliasResultTypeDef#

# AssociateConnectionAliasResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociateConnectionAliasResultTypeDef


def get_value() -> AssociateConnectionAliasResultTypeDef:
    return {
        "ConnectionIdentifier": ...,
    }


# AssociateConnectionAliasResultTypeDef definition

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

CopyWorkspaceImageResultTypeDef#

# CopyWorkspaceImageResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CopyWorkspaceImageResultTypeDef


def get_value() -> CopyWorkspaceImageResultTypeDef:
    return {
        "ImageId": ...,
    }


# CopyWorkspaceImageResultTypeDef definition

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

CreateAccountLinkInvitationResultTypeDef#

# CreateAccountLinkInvitationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateAccountLinkInvitationResultTypeDef


def get_value() -> CreateAccountLinkInvitationResultTypeDef:
    return {
        "AccountLink": ...,
    }


# CreateAccountLinkInvitationResultTypeDef definition

class CreateAccountLinkInvitationResultTypeDef(TypedDict):
    AccountLink: AccountLinkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLinkTypeDef
  2. See ResponseMetadataTypeDef

CreateConnectClientAddInResultTypeDef#

# CreateConnectClientAddInResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateConnectClientAddInResultTypeDef


def get_value() -> CreateConnectClientAddInResultTypeDef:
    return {
        "AddInId": ...,
    }


# CreateConnectClientAddInResultTypeDef definition

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

CreateConnectionAliasResultTypeDef#

# CreateConnectionAliasResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateConnectionAliasResultTypeDef


def get_value() -> CreateConnectionAliasResultTypeDef:
    return {
        "AliasId": ...,
    }


# CreateConnectionAliasResultTypeDef definition

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

CreateIpGroupResultTypeDef#

# CreateIpGroupResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateIpGroupResultTypeDef


def get_value() -> CreateIpGroupResultTypeDef:
    return {
        "GroupId": ...,
    }


# CreateIpGroupResultTypeDef definition

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

CreateUpdatedWorkspaceImageResultTypeDef#

# CreateUpdatedWorkspaceImageResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateUpdatedWorkspaceImageResultTypeDef


def get_value() -> CreateUpdatedWorkspaceImageResultTypeDef:
    return {
        "ImageId": ...,
    }


# CreateUpdatedWorkspaceImageResultTypeDef definition

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

DeleteAccountLinkInvitationResultTypeDef#

# DeleteAccountLinkInvitationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeleteAccountLinkInvitationResultTypeDef


def get_value() -> DeleteAccountLinkInvitationResultTypeDef:
    return {
        "AccountLink": ...,
    }


# DeleteAccountLinkInvitationResultTypeDef definition

class DeleteAccountLinkInvitationResultTypeDef(TypedDict):
    AccountLink: AccountLinkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLinkTypeDef
  2. See ResponseMetadataTypeDef

DescribeAccountResultTypeDef#

# DescribeAccountResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeAccountResultTypeDef


def get_value() -> DescribeAccountResultTypeDef:
    return {
        "DedicatedTenancySupport": ...,
    }


# DescribeAccountResultTypeDef definition

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

GetAccountLinkResultTypeDef#

# GetAccountLinkResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import GetAccountLinkResultTypeDef


def get_value() -> GetAccountLinkResultTypeDef:
    return {
        "AccountLink": ...,
    }


# GetAccountLinkResultTypeDef definition

class GetAccountLinkResultTypeDef(TypedDict):
    AccountLink: AccountLinkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLinkTypeDef
  2. See ResponseMetadataTypeDef

ImportWorkspaceImageResultTypeDef#

# ImportWorkspaceImageResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImportWorkspaceImageResultTypeDef


def get_value() -> ImportWorkspaceImageResultTypeDef:
    return {
        "ImageId": ...,
    }


# ImportWorkspaceImageResultTypeDef definition

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

ListAccountLinksResultTypeDef#

# ListAccountLinksResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAccountLinksResultTypeDef


def get_value() -> ListAccountLinksResultTypeDef:
    return {
        "AccountLinks": ...,
    }


# ListAccountLinksResultTypeDef definition

class ListAccountLinksResultTypeDef(TypedDict):
    AccountLinks: List[AccountLinkTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[AccountLinkTypeDef]
  2. See ResponseMetadataTypeDef

ListAvailableManagementCidrRangesResultTypeDef#

# ListAvailableManagementCidrRangesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesResultTypeDef


def get_value() -> ListAvailableManagementCidrRangesResultTypeDef:
    return {
        "ManagementCidrRanges": ...,
    }


# ListAvailableManagementCidrRangesResultTypeDef definition

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

MigrateWorkspaceResultTypeDef#

# MigrateWorkspaceResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import MigrateWorkspaceResultTypeDef


def get_value() -> MigrateWorkspaceResultTypeDef:
    return {
        "SourceWorkspaceId": ...,
    }


# MigrateWorkspaceResultTypeDef definition

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

RegisterWorkspaceDirectoryResultTypeDef#

# RegisterWorkspaceDirectoryResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RegisterWorkspaceDirectoryResultTypeDef


def get_value() -> RegisterWorkspaceDirectoryResultTypeDef:
    return {
        "DirectoryId": ...,
    }


# RegisterWorkspaceDirectoryResultTypeDef definition

class RegisterWorkspaceDirectoryResultTypeDef(TypedDict):
    DirectoryId: str,
    State: WorkspaceDirectoryStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDirectoryStateType
  2. See ResponseMetadataTypeDef

RejectAccountLinkInvitationResultTypeDef#

# RejectAccountLinkInvitationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RejectAccountLinkInvitationResultTypeDef


def get_value() -> RejectAccountLinkInvitationResultTypeDef:
    return {
        "AccountLink": ...,
    }


# RejectAccountLinkInvitationResultTypeDef definition

class RejectAccountLinkInvitationResultTypeDef(TypedDict):
    AccountLink: AccountLinkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLinkTypeDef
  2. See ResponseMetadataTypeDef

DescribeAccountModificationsResultTypeDef#

# DescribeAccountModificationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsResultTypeDef


def get_value() -> DescribeAccountModificationsResultTypeDef:
    return {
        "AccountModifications": ...,
    }


# DescribeAccountModificationsResultTypeDef definition

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

ApplicationResourceAssociationTypeDef#

# ApplicationResourceAssociationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ApplicationResourceAssociationTypeDef


def get_value() -> ApplicationResourceAssociationTypeDef:
    return {
        "ApplicationId": ...,
    }


# ApplicationResourceAssociationTypeDef definition

class ApplicationResourceAssociationTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    AssociatedResourceId: NotRequired[str],
    AssociatedResourceType: NotRequired[ApplicationAssociatedResourceTypeType],  # (1)
    Created: NotRequired[datetime.datetime],
    LastUpdatedTime: NotRequired[datetime.datetime],
    State: NotRequired[AssociationStateType],  # (2)
    StateReason: NotRequired[AssociationStateReasonTypeDef],  # (3)
  1. See ApplicationAssociatedResourceTypeType
  2. See AssociationStateType
  3. See AssociationStateReasonTypeDef

BundleResourceAssociationTypeDef#

# BundleResourceAssociationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import BundleResourceAssociationTypeDef


def get_value() -> BundleResourceAssociationTypeDef:
    return {
        "AssociatedResourceId": ...,
    }


# BundleResourceAssociationTypeDef definition

class BundleResourceAssociationTypeDef(TypedDict):
    AssociatedResourceId: NotRequired[str],
    AssociatedResourceType: NotRequired[BundleAssociatedResourceTypeType],  # (1)
    BundleId: NotRequired[str],
    Created: NotRequired[datetime.datetime],
    LastUpdatedTime: NotRequired[datetime.datetime],
    State: NotRequired[AssociationStateType],  # (2)
    StateReason: NotRequired[AssociationStateReasonTypeDef],  # (3)
  1. See BundleAssociatedResourceTypeType
  2. See AssociationStateType
  3. See AssociationStateReasonTypeDef

ImageResourceAssociationTypeDef#

# ImageResourceAssociationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImageResourceAssociationTypeDef


def get_value() -> ImageResourceAssociationTypeDef:
    return {
        "AssociatedResourceId": ...,
    }


# ImageResourceAssociationTypeDef definition

class ImageResourceAssociationTypeDef(TypedDict):
    AssociatedResourceId: NotRequired[str],
    AssociatedResourceType: NotRequired[ImageAssociatedResourceTypeType],  # (1)
    Created: NotRequired[datetime.datetime],
    LastUpdatedTime: NotRequired[datetime.datetime],
    ImageId: NotRequired[str],
    State: NotRequired[AssociationStateType],  # (2)
    StateReason: NotRequired[AssociationStateReasonTypeDef],  # (3)
  1. See ImageAssociatedResourceTypeType
  2. See AssociationStateType
  3. See AssociationStateReasonTypeDef

WorkspaceResourceAssociationTypeDef#

# WorkspaceResourceAssociationTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceResourceAssociationTypeDef


def get_value() -> WorkspaceResourceAssociationTypeDef:
    return {
        "AssociatedResourceId": ...,
    }


# WorkspaceResourceAssociationTypeDef definition

class WorkspaceResourceAssociationTypeDef(TypedDict):
    AssociatedResourceId: NotRequired[str],
    AssociatedResourceType: NotRequired[WorkSpaceAssociatedResourceTypeType],  # (1)
    Created: NotRequired[datetime.datetime],
    LastUpdatedTime: NotRequired[datetime.datetime],
    State: NotRequired[AssociationStateType],  # (2)
    StateReason: NotRequired[AssociationStateReasonTypeDef],  # (3)
    WorkspaceId: NotRequired[str],
  1. See WorkSpaceAssociatedResourceTypeType
  2. See AssociationStateType
  3. See AssociationStateReasonTypeDef

AuthorizeIpRulesRequestTypeDef#

# AuthorizeIpRulesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AuthorizeIpRulesRequestTypeDef


def get_value() -> AuthorizeIpRulesRequestTypeDef:
    return {
        "GroupId": ...,
    }


# AuthorizeIpRulesRequestTypeDef definition

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

UpdateRulesOfIpGroupRequestTypeDef#

# UpdateRulesOfIpGroupRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateRulesOfIpGroupRequestTypeDef


def get_value() -> UpdateRulesOfIpGroupRequestTypeDef:
    return {
        "GroupId": ...,
    }


# UpdateRulesOfIpGroupRequestTypeDef definition

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

WorkspacesIpGroupTypeDef#

# WorkspacesIpGroupTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacesIpGroupTypeDef


def get_value() -> WorkspacesIpGroupTypeDef:
    return {
        "groupId": ...,
    }


# WorkspacesIpGroupTypeDef definition

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

DefaultImportClientBrandingAttributesTypeDef#

# DefaultImportClientBrandingAttributesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DefaultImportClientBrandingAttributesTypeDef


def get_value() -> DefaultImportClientBrandingAttributesTypeDef:
    return {
        "Logo": ...,
    }


# DefaultImportClientBrandingAttributesTypeDef definition

class DefaultImportClientBrandingAttributesTypeDef(TypedDict):
    Logo: NotRequired[BlobTypeDef],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Mapping[str, str]],

IosImportClientBrandingAttributesTypeDef#

# IosImportClientBrandingAttributesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import IosImportClientBrandingAttributesTypeDef


def get_value() -> IosImportClientBrandingAttributesTypeDef:
    return {
        "Logo": ...,
    }


# IosImportClientBrandingAttributesTypeDef definition

class IosImportClientBrandingAttributesTypeDef(TypedDict):
    Logo: NotRequired[BlobTypeDef],
    Logo2x: NotRequired[BlobTypeDef],
    Logo3x: NotRequired[BlobTypeDef],
    SupportEmail: NotRequired[str],
    SupportLink: NotRequired[str],
    ForgotPasswordLink: NotRequired[str],
    LoginMessage: NotRequired[Mapping[str, str]],

ModifyCertificateBasedAuthPropertiesRequestTypeDef#

# ModifyCertificateBasedAuthPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyCertificateBasedAuthPropertiesRequestTypeDef


def get_value() -> ModifyCertificateBasedAuthPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifyCertificateBasedAuthPropertiesRequestTypeDef definition

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

ClientPropertiesResultTypeDef#

# ClientPropertiesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ClientPropertiesResultTypeDef


def get_value() -> ClientPropertiesResultTypeDef:
    return {
        "ResourceId": ...,
    }


# ClientPropertiesResultTypeDef definition

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

ModifyClientPropertiesRequestTypeDef#

# ModifyClientPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyClientPropertiesRequestTypeDef


def get_value() -> ModifyClientPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifyClientPropertiesRequestTypeDef definition

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

DescribeConnectClientAddInsResultTypeDef#

# DescribeConnectClientAddInsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectClientAddInsResultTypeDef


def get_value() -> DescribeConnectClientAddInsResultTypeDef:
    return {
        "AddIns": ...,
    }


# DescribeConnectClientAddInsResultTypeDef definition

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

ConnectionAliasTypeDef#

# ConnectionAliasTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ConnectionAliasTypeDef


def get_value() -> ConnectionAliasTypeDef:
    return {
        "ConnectionString": ...,
    }


# 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 List[ConnectionAliasAssociationTypeDef]

DescribeConnectionAliasPermissionsResultTypeDef#

# DescribeConnectionAliasPermissionsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasPermissionsResultTypeDef


def get_value() -> DescribeConnectionAliasPermissionsResultTypeDef:
    return {
        "AliasId": ...,
    }


# DescribeConnectionAliasPermissionsResultTypeDef definition

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

UpdateConnectionAliasPermissionRequestTypeDef#

# UpdateConnectionAliasPermissionRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateConnectionAliasPermissionRequestTypeDef


def get_value() -> UpdateConnectionAliasPermissionRequestTypeDef:
    return {
        "AliasId": ...,
    }


# UpdateConnectionAliasPermissionRequestTypeDef definition

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

CopyWorkspaceImageRequestTypeDef#

# CopyWorkspaceImageRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CopyWorkspaceImageRequestTypeDef


def get_value() -> CopyWorkspaceImageRequestTypeDef:
    return {
        "Name": ...,
    }


# CopyWorkspaceImageRequestTypeDef definition

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

CreateConnectionAliasRequestTypeDef#

# CreateConnectionAliasRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateConnectionAliasRequestTypeDef


def get_value() -> CreateConnectionAliasRequestTypeDef:
    return {
        "ConnectionString": ...,
    }


# CreateConnectionAliasRequestTypeDef definition

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

CreateIpGroupRequestTypeDef#

# CreateIpGroupRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateIpGroupRequestTypeDef


def get_value() -> CreateIpGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# CreateIpGroupRequestTypeDef definition

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

CreateTagsRequestTypeDef#

# CreateTagsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateTagsRequestTypeDef


def get_value() -> CreateTagsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# CreateTagsRequestTypeDef definition

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

CreateUpdatedWorkspaceImageRequestTypeDef#

# CreateUpdatedWorkspaceImageRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateUpdatedWorkspaceImageRequestTypeDef


def get_value() -> CreateUpdatedWorkspaceImageRequestTypeDef:
    return {
        "Name": ...,
    }


# CreateUpdatedWorkspaceImageRequestTypeDef definition

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

CreateWorkspaceImageRequestTypeDef#

# CreateWorkspaceImageRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspaceImageRequestTypeDef


def get_value() -> CreateWorkspaceImageRequestTypeDef:
    return {
        "Name": ...,
    }


# CreateWorkspaceImageRequestTypeDef definition

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

DescribeTagsResultTypeDef#

# DescribeTagsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeTagsResultTypeDef


def get_value() -> DescribeTagsResultTypeDef:
    return {
        "TagList": ...,
    }


# DescribeTagsResultTypeDef definition

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

ImportWorkspaceImageRequestTypeDef#

# ImportWorkspaceImageRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImportWorkspaceImageRequestTypeDef


def get_value() -> ImportWorkspaceImageRequestTypeDef:
    return {
        "Ec2ImageId": ...,
    }


# ImportWorkspaceImageRequestTypeDef definition

class ImportWorkspaceImageRequestTypeDef(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 Sequence[TagTypeDef]
  3. See Sequence[ApplicationType]

StandbyWorkspaceOutputTypeDef#

# StandbyWorkspaceOutputTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StandbyWorkspaceOutputTypeDef


def get_value() -> StandbyWorkspaceOutputTypeDef:
    return {
        "PrimaryWorkspaceId": ...,
    }


# StandbyWorkspaceOutputTypeDef definition

class StandbyWorkspaceOutputTypeDef(TypedDict):
    PrimaryWorkspaceId: str,
    DirectoryId: str,
    VolumeEncryptionKey: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    DataReplication: NotRequired[DataReplicationType],  # (2)
  1. See List[TagTypeDef]
  2. See DataReplicationType

StandbyWorkspaceTypeDef#

# StandbyWorkspaceTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StandbyWorkspaceTypeDef


def get_value() -> StandbyWorkspaceTypeDef:
    return {
        "PrimaryWorkspaceId": ...,
    }


# StandbyWorkspaceTypeDef definition

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

CreateWorkspaceBundleRequestTypeDef#

# CreateWorkspaceBundleRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspaceBundleRequestTypeDef


def get_value() -> CreateWorkspaceBundleRequestTypeDef:
    return {
        "BundleName": ...,
    }


# CreateWorkspaceBundleRequestTypeDef definition

class CreateWorkspaceBundleRequestTypeDef(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 Sequence[TagTypeDef]

WorkspaceBundleTypeDef#

# WorkspaceBundleTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceBundleTypeDef


def get_value() -> WorkspaceBundleTypeDef:
    return {
        "BundleId": ...,
    }


# 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.datetime],
    CreationTime: NotRequired[datetime.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 TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspaceImageResultTypeDef


def get_value() -> CreateWorkspaceImageResultTypeDef:
    return {
        "ImageId": ...,
    }


# CreateWorkspaceImageResultTypeDef definition

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

CreateWorkspacesPoolRequestTypeDef#

# CreateWorkspacesPoolRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspacesPoolRequestTypeDef


def get_value() -> CreateWorkspacesPoolRequestTypeDef:
    return {
        "PoolName": ...,
    }


# CreateWorkspacesPoolRequestTypeDef definition

class CreateWorkspacesPoolRequestTypeDef(TypedDict):
    PoolName: str,
    Description: str,
    BundleId: str,
    DirectoryId: str,
    Capacity: CapacityTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    ApplicationSettings: NotRequired[ApplicationSettingsRequestTypeDef],  # (3)
    TimeoutSettings: NotRequired[TimeoutSettingsTypeDef],  # (4)
  1. See CapacityTypeDef
  2. See Sequence[TagTypeDef]
  3. See ApplicationSettingsRequestTypeDef
  4. See TimeoutSettingsTypeDef

UpdateWorkspacesPoolRequestTypeDef#

# UpdateWorkspacesPoolRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateWorkspacesPoolRequestTypeDef


def get_value() -> UpdateWorkspacesPoolRequestTypeDef:
    return {
        "PoolId": ...,
    }


# UpdateWorkspacesPoolRequestTypeDef definition

class UpdateWorkspacesPoolRequestTypeDef(TypedDict):
    PoolId: str,
    Description: NotRequired[str],
    BundleId: NotRequired[str],
    DirectoryId: NotRequired[str],
    Capacity: NotRequired[CapacityTypeDef],  # (1)
    ApplicationSettings: NotRequired[ApplicationSettingsRequestTypeDef],  # (2)
    TimeoutSettings: NotRequired[TimeoutSettingsTypeDef],  # (3)
  1. See CapacityTypeDef
  2. See ApplicationSettingsRequestTypeDef
  3. See TimeoutSettingsTypeDef

DescribeAccountModificationsRequestPaginateTypeDef#

# DescribeAccountModificationsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeAccountModificationsRequestPaginateTypeDef


def get_value() -> DescribeAccountModificationsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# DescribeAccountModificationsRequestPaginateTypeDef definition

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

DescribeIpGroupsRequestPaginateTypeDef#

# DescribeIpGroupsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeIpGroupsRequestPaginateTypeDef


def get_value() -> DescribeIpGroupsRequestPaginateTypeDef:
    return {
        "GroupIds": ...,
    }


# DescribeIpGroupsRequestPaginateTypeDef definition

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

DescribeWorkspaceBundlesRequestPaginateTypeDef#

# DescribeWorkspaceBundlesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesRequestPaginateTypeDef


def get_value() -> DescribeWorkspaceBundlesRequestPaginateTypeDef:
    return {
        "BundleIds": ...,
    }


# DescribeWorkspaceBundlesRequestPaginateTypeDef definition

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

DescribeWorkspaceImagesRequestPaginateTypeDef#

# DescribeWorkspaceImagesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesRequestPaginateTypeDef


def get_value() -> DescribeWorkspaceImagesRequestPaginateTypeDef:
    return {
        "ImageIds": ...,
    }


# DescribeWorkspaceImagesRequestPaginateTypeDef definition

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

DescribeWorkspacesConnectionStatusRequestPaginateTypeDef#

# DescribeWorkspacesConnectionStatusRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusRequestPaginateTypeDef


def get_value() -> DescribeWorkspacesConnectionStatusRequestPaginateTypeDef:
    return {
        "WorkspaceIds": ...,
    }


# DescribeWorkspacesConnectionStatusRequestPaginateTypeDef definition

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

DescribeWorkspacesRequestPaginateTypeDef#

# DescribeWorkspacesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesRequestPaginateTypeDef


def get_value() -> DescribeWorkspacesRequestPaginateTypeDef:
    return {
        "WorkspaceIds": ...,
    }


# DescribeWorkspacesRequestPaginateTypeDef definition

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

ListAccountLinksRequestPaginateTypeDef#

# ListAccountLinksRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAccountLinksRequestPaginateTypeDef


def get_value() -> ListAccountLinksRequestPaginateTypeDef:
    return {
        "LinkStatusFilter": ...,
    }


# ListAccountLinksRequestPaginateTypeDef definition

class ListAccountLinksRequestPaginateTypeDef(TypedDict):
    LinkStatusFilter: NotRequired[Sequence[AccountLinkStatusEnumType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Sequence[AccountLinkStatusEnumType]
  2. See PaginatorConfigTypeDef

ListAvailableManagementCidrRangesRequestPaginateTypeDef#

# ListAvailableManagementCidrRangesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ListAvailableManagementCidrRangesRequestPaginateTypeDef


def get_value() -> ListAvailableManagementCidrRangesRequestPaginateTypeDef:
    return {
        "ManagementCidrRangeConstraint": ...,
    }


# ListAvailableManagementCidrRangesRequestPaginateTypeDef definition

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

DescribeApplicationsResultTypeDef#

# DescribeApplicationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeApplicationsResultTypeDef


def get_value() -> DescribeApplicationsResultTypeDef:
    return {
        "Applications": ...,
    }


# DescribeApplicationsResultTypeDef definition

class DescribeApplicationsResultTypeDef(TypedDict):
    Applications: List[WorkSpaceApplicationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[WorkSpaceApplicationTypeDef]
  2. See ResponseMetadataTypeDef

DescribeClientBrandingResultTypeDef#

# DescribeClientBrandingResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeClientBrandingResultTypeDef


def get_value() -> DescribeClientBrandingResultTypeDef:
    return {
        "DeviceTypeWindows": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImportClientBrandingResultTypeDef


def get_value() -> ImportClientBrandingResultTypeDef:
    return {
        "DeviceTypeWindows": ...,
    }


# 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

DescribeWorkspaceDirectoriesRequestPaginateTypeDef#

# DescribeWorkspaceDirectoriesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesRequestPaginateTypeDef


def get_value() -> DescribeWorkspaceDirectoriesRequestPaginateTypeDef:
    return {
        "DirectoryIds": ...,
    }


# DescribeWorkspaceDirectoriesRequestPaginateTypeDef definition

class DescribeWorkspaceDirectoriesRequestPaginateTypeDef(TypedDict):
    DirectoryIds: NotRequired[Sequence[str]],
    WorkspaceDirectoryNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    Filters: NotRequired[Sequence[DescribeWorkspaceDirectoriesFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Sequence[DescribeWorkspaceDirectoriesFilterTypeDef]
  2. See PaginatorConfigTypeDef

DescribeWorkspaceDirectoriesRequestTypeDef#

# DescribeWorkspaceDirectoriesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesRequestTypeDef


def get_value() -> DescribeWorkspaceDirectoriesRequestTypeDef:
    return {
        "DirectoryIds": ...,
    }


# DescribeWorkspaceDirectoriesRequestTypeDef definition

class DescribeWorkspaceDirectoriesRequestTypeDef(TypedDict):
    DirectoryIds: NotRequired[Sequence[str]],
    WorkspaceDirectoryNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[DescribeWorkspaceDirectoriesFilterTypeDef]],  # (1)
  1. See Sequence[DescribeWorkspaceDirectoriesFilterTypeDef]

DescribeWorkspaceImagePermissionsResultTypeDef#

# DescribeWorkspaceImagePermissionsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagePermissionsResultTypeDef


def get_value() -> DescribeWorkspaceImagePermissionsResultTypeDef:
    return {
        "ImageId": ...,
    }


# DescribeWorkspaceImagePermissionsResultTypeDef definition

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

DescribeWorkspaceSnapshotsResultTypeDef#

# DescribeWorkspaceSnapshotsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceSnapshotsResultTypeDef


def get_value() -> DescribeWorkspaceSnapshotsResultTypeDef:
    return {
        "RebuildSnapshots": ...,
    }


# DescribeWorkspaceSnapshotsResultTypeDef definition

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

DescribeWorkspacesConnectionStatusResultTypeDef#

# DescribeWorkspacesConnectionStatusResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesConnectionStatusResultTypeDef


def get_value() -> DescribeWorkspacesConnectionStatusResultTypeDef:
    return {
        "WorkspacesConnectionStatus": ...,
    }


# DescribeWorkspacesConnectionStatusResultTypeDef definition

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

DescribeWorkspacesPoolsRequestTypeDef#

# DescribeWorkspacesPoolsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesPoolsRequestTypeDef


def get_value() -> DescribeWorkspacesPoolsRequestTypeDef:
    return {
        "PoolIds": ...,
    }


# DescribeWorkspacesPoolsRequestTypeDef definition

class DescribeWorkspacesPoolsRequestTypeDef(TypedDict):
    PoolIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[DescribeWorkspacesPoolsFilterTypeDef]],  # (1)
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
  1. See Sequence[DescribeWorkspacesPoolsFilterTypeDef]

RebootWorkspacesResultTypeDef#

# RebootWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebootWorkspacesResultTypeDef


def get_value() -> RebootWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# RebootWorkspacesResultTypeDef definition

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

RebuildWorkspacesResultTypeDef#

# RebuildWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebuildWorkspacesResultTypeDef


def get_value() -> RebuildWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# RebuildWorkspacesResultTypeDef definition

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

StartWorkspacesResultTypeDef#

# StartWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StartWorkspacesResultTypeDef


def get_value() -> StartWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# StartWorkspacesResultTypeDef definition

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

StopWorkspacesResultTypeDef#

# StopWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StopWorkspacesResultTypeDef


def get_value() -> StopWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# StopWorkspacesResultTypeDef definition

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

TerminateWorkspacesResultTypeDef#

# TerminateWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TerminateWorkspacesResultTypeDef


def get_value() -> TerminateWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# TerminateWorkspacesResultTypeDef definition

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

WorkspacePropertiesOutputTypeDef#

# WorkspacePropertiesOutputTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacePropertiesOutputTypeDef


def get_value() -> WorkspacePropertiesOutputTypeDef:
    return {
        "RunningMode": ...,
    }


# WorkspacePropertiesOutputTypeDef definition

class WorkspacePropertiesOutputTypeDef(TypedDict):
    RunningMode: NotRequired[RunningModeType],  # (1)
    RunningModeAutoStopTimeoutInMinutes: NotRequired[int],
    RootVolumeSizeGib: NotRequired[int],
    UserVolumeSizeGib: NotRequired[int],
    ComputeTypeName: NotRequired[ComputeType],  # (2)
    Protocols: NotRequired[List[ProtocolType]],  # (3)
    OperatingSystemName: NotRequired[OperatingSystemNameType],  # (4)
    GlobalAccelerator: NotRequired[GlobalAcceleratorForWorkSpaceTypeDef],  # (5)
  1. See RunningModeType
  2. See ComputeType
  3. See List[ProtocolType]
  4. See OperatingSystemNameType
  5. See GlobalAcceleratorForWorkSpaceTypeDef

WorkspacePropertiesTypeDef#

# WorkspacePropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacePropertiesTypeDef


def get_value() -> WorkspacePropertiesTypeDef:
    return {
        "RunningMode": ...,
    }


# 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)
    OperatingSystemName: NotRequired[OperatingSystemNameType],  # (4)
    GlobalAccelerator: NotRequired[GlobalAcceleratorForWorkSpaceTypeDef],  # (5)
  1. See RunningModeType
  2. See ComputeType
  3. See Sequence[ProtocolType]
  4. See OperatingSystemNameType
  5. See GlobalAcceleratorForWorkSpaceTypeDef

RegisterWorkspaceDirectoryRequestTypeDef#

# RegisterWorkspaceDirectoryRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RegisterWorkspaceDirectoryRequestTypeDef


def get_value() -> RegisterWorkspaceDirectoryRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# RegisterWorkspaceDirectoryRequestTypeDef definition

class RegisterWorkspaceDirectoryRequestTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    SubnetIds: NotRequired[Sequence[str]],
    EnableWorkDocs: NotRequired[bool],
    EnableSelfService: NotRequired[bool],
    Tenancy: NotRequired[TenancyType],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    WorkspaceDirectoryName: NotRequired[str],
    WorkspaceDirectoryDescription: NotRequired[str],
    UserIdentityType: NotRequired[UserIdentityTypeType],  # (3)
    IdcInstanceArn: NotRequired[str],
    MicrosoftEntraConfig: NotRequired[MicrosoftEntraConfigTypeDef],  # (4)
    WorkspaceType: NotRequired[WorkspaceTypeType],  # (5)
    ActiveDirectoryConfig: NotRequired[ActiveDirectoryConfigTypeDef],  # (6)
  1. See TenancyType
  2. See Sequence[TagTypeDef]
  3. See UserIdentityTypeType
  4. See MicrosoftEntraConfigTypeDef
  5. See WorkspaceTypeType
  6. See ActiveDirectoryConfigTypeDef

ModifySamlPropertiesRequestTypeDef#

# ModifySamlPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifySamlPropertiesRequestTypeDef


def get_value() -> ModifySamlPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifySamlPropertiesRequestTypeDef definition

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

ModifySelfservicePermissionsRequestTypeDef#

# ModifySelfservicePermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifySelfservicePermissionsRequestTypeDef


def get_value() -> ModifySelfservicePermissionsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifySelfservicePermissionsRequestTypeDef definition

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

ModifyWorkspaceAccessPropertiesRequestTypeDef#

# ModifyWorkspaceAccessPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyWorkspaceAccessPropertiesRequestTypeDef


def get_value() -> ModifyWorkspaceAccessPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifyWorkspaceAccessPropertiesRequestTypeDef definition

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

ModifyWorkspaceCreationPropertiesRequestTypeDef#

# ModifyWorkspaceCreationPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyWorkspaceCreationPropertiesRequestTypeDef


def get_value() -> ModifyWorkspaceCreationPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifyWorkspaceCreationPropertiesRequestTypeDef definition

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

WorkspacesPoolSessionTypeDef#

# WorkspacesPoolSessionTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacesPoolSessionTypeDef


def get_value() -> WorkspacesPoolSessionTypeDef:
    return {
        "AuthenticationType": ...,
    }


# WorkspacesPoolSessionTypeDef definition

class WorkspacesPoolSessionTypeDef(TypedDict):
    SessionId: str,
    PoolId: str,
    UserId: str,
    AuthenticationType: NotRequired[AuthenticationTypeType],  # (1)
    ConnectionState: NotRequired[SessionConnectionStateType],  # (2)
    InstanceId: NotRequired[str],
    ExpirationTime: NotRequired[datetime.datetime],
    NetworkAccessConfiguration: NotRequired[NetworkAccessConfigurationTypeDef],  # (3)
    StartTime: NotRequired[datetime.datetime],
  1. See AuthenticationTypeType
  2. See SessionConnectionStateType
  3. See NetworkAccessConfigurationTypeDef

RebootWorkspacesRequestTypeDef#

# RebootWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebootWorkspacesRequestTypeDef


def get_value() -> RebootWorkspacesRequestTypeDef:
    return {
        "RebootWorkspaceRequests": ...,
    }


# RebootWorkspacesRequestTypeDef definition

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

RebuildWorkspacesRequestTypeDef#

# RebuildWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import RebuildWorkspacesRequestTypeDef


def get_value() -> RebuildWorkspacesRequestTypeDef:
    return {
        "RebuildWorkspaceRequests": ...,
    }


# RebuildWorkspacesRequestTypeDef definition

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

StartWorkspacesRequestTypeDef#

# StartWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StartWorkspacesRequestTypeDef


def get_value() -> StartWorkspacesRequestTypeDef:
    return {
        "StartWorkspaceRequests": ...,
    }


# StartWorkspacesRequestTypeDef definition

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

StopWorkspacesRequestTypeDef#

# StopWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StopWorkspacesRequestTypeDef


def get_value() -> StopWorkspacesRequestTypeDef:
    return {
        "StopWorkspaceRequests": ...,
    }


# StopWorkspacesRequestTypeDef definition

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

StreamingPropertiesOutputTypeDef#

# StreamingPropertiesOutputTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StreamingPropertiesOutputTypeDef


def get_value() -> StreamingPropertiesOutputTypeDef:
    return {
        "StreamingExperiencePreferredProtocol": ...,
    }


# StreamingPropertiesOutputTypeDef definition

class StreamingPropertiesOutputTypeDef(TypedDict):
    StreamingExperiencePreferredProtocol: NotRequired[StreamingExperiencePreferredProtocolEnumType],  # (1)
    UserSettings: NotRequired[List[UserSettingTypeDef]],  # (2)
    StorageConnectors: NotRequired[List[StorageConnectorTypeDef]],  # (3)
    GlobalAccelerator: NotRequired[GlobalAcceleratorForDirectoryTypeDef],  # (4)
  1. See StreamingExperiencePreferredProtocolEnumType
  2. See List[UserSettingTypeDef]
  3. See List[StorageConnectorTypeDef]
  4. See GlobalAcceleratorForDirectoryTypeDef

StreamingPropertiesTypeDef#

# StreamingPropertiesTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import StreamingPropertiesTypeDef


def get_value() -> StreamingPropertiesTypeDef:
    return {
        "StreamingExperiencePreferredProtocol": ...,
    }


# StreamingPropertiesTypeDef definition

class StreamingPropertiesTypeDef(TypedDict):
    StreamingExperiencePreferredProtocol: NotRequired[StreamingExperiencePreferredProtocolEnumType],  # (1)
    UserSettings: NotRequired[Sequence[UserSettingTypeDef]],  # (2)
    StorageConnectors: NotRequired[Sequence[StorageConnectorTypeDef]],  # (3)
    GlobalAccelerator: NotRequired[GlobalAcceleratorForDirectoryTypeDef],  # (4)
  1. See StreamingExperiencePreferredProtocolEnumType
  2. See Sequence[UserSettingTypeDef]
  3. See Sequence[StorageConnectorTypeDef]
  4. See GlobalAcceleratorForDirectoryTypeDef

TerminateWorkspacesRequestTypeDef#

# TerminateWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import TerminateWorkspacesRequestTypeDef


def get_value() -> TerminateWorkspacesRequestTypeDef:
    return {
        "TerminateWorkspaceRequests": ...,
    }


# TerminateWorkspacesRequestTypeDef definition

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

WorkspaceImageTypeDef#

# WorkspaceImageTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceImageTypeDef


def get_value() -> WorkspaceImageTypeDef:
    return {
        "ImageId": ...,
    }


# 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.datetime],
    OwnerAccountId: NotRequired[str],
    Updates: NotRequired[UpdateResultTypeDef],  # (4)
    ErrorDetails: NotRequired[List[ErrorDetailsTypeDef]],  # (5)
  1. See OperatingSystemTypeDef
  2. See WorkspaceImageStateType
  3. See WorkspaceImageRequiredTenancyType
  4. See UpdateResultTypeDef
  5. See List[ErrorDetailsTypeDef]

WorkspacesPoolTypeDef#

# WorkspacesPoolTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspacesPoolTypeDef


def get_value() -> WorkspacesPoolTypeDef:
    return {
        "PoolId": ...,
    }


# WorkspacesPoolTypeDef definition

class WorkspacesPoolTypeDef(TypedDict):
    PoolId: str,
    PoolArn: str,
    CapacityStatus: CapacityStatusTypeDef,  # (1)
    PoolName: str,
    State: WorkspacesPoolStateType,  # (2)
    CreatedAt: datetime.datetime,
    BundleId: str,
    DirectoryId: str,
    Description: NotRequired[str],
    Errors: NotRequired[List[WorkspacesPoolErrorTypeDef]],  # (3)
    ApplicationSettings: NotRequired[ApplicationSettingsResponseTypeDef],  # (4)
    TimeoutSettings: NotRequired[TimeoutSettingsTypeDef],  # (5)
  1. See CapacityStatusTypeDef
  2. See WorkspacesPoolStateType
  3. See List[WorkspacesPoolErrorTypeDef]
  4. See ApplicationSettingsResponseTypeDef
  5. See TimeoutSettingsTypeDef

DescribeApplicationAssociationsResultTypeDef#

# DescribeApplicationAssociationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeApplicationAssociationsResultTypeDef


def get_value() -> DescribeApplicationAssociationsResultTypeDef:
    return {
        "Associations": ...,
    }


# DescribeApplicationAssociationsResultTypeDef definition

class DescribeApplicationAssociationsResultTypeDef(TypedDict):
    Associations: List[ApplicationResourceAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[ApplicationResourceAssociationTypeDef]
  2. See ResponseMetadataTypeDef

DescribeBundleAssociationsResultTypeDef#

# DescribeBundleAssociationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeBundleAssociationsResultTypeDef


def get_value() -> DescribeBundleAssociationsResultTypeDef:
    return {
        "Associations": ...,
    }


# DescribeBundleAssociationsResultTypeDef definition

class DescribeBundleAssociationsResultTypeDef(TypedDict):
    Associations: List[BundleResourceAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[BundleResourceAssociationTypeDef]
  2. See ResponseMetadataTypeDef

DescribeImageAssociationsResultTypeDef#

# DescribeImageAssociationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeImageAssociationsResultTypeDef


def get_value() -> DescribeImageAssociationsResultTypeDef:
    return {
        "Associations": ...,
    }


# DescribeImageAssociationsResultTypeDef definition

class DescribeImageAssociationsResultTypeDef(TypedDict):
    Associations: List[ImageResourceAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[ImageResourceAssociationTypeDef]
  2. See ResponseMetadataTypeDef

AssociateWorkspaceApplicationResultTypeDef#

# AssociateWorkspaceApplicationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import AssociateWorkspaceApplicationResultTypeDef


def get_value() -> AssociateWorkspaceApplicationResultTypeDef:
    return {
        "Association": ...,
    }


# AssociateWorkspaceApplicationResultTypeDef definition

class AssociateWorkspaceApplicationResultTypeDef(TypedDict):
    Association: WorkspaceResourceAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceResourceAssociationTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceAssociationsResultTypeDef#

# DescribeWorkspaceAssociationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceAssociationsResultTypeDef


def get_value() -> DescribeWorkspaceAssociationsResultTypeDef:
    return {
        "Associations": ...,
    }


# DescribeWorkspaceAssociationsResultTypeDef definition

class DescribeWorkspaceAssociationsResultTypeDef(TypedDict):
    Associations: List[WorkspaceResourceAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[WorkspaceResourceAssociationTypeDef]
  2. See ResponseMetadataTypeDef

DisassociateWorkspaceApplicationResultTypeDef#

# DisassociateWorkspaceApplicationResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DisassociateWorkspaceApplicationResultTypeDef


def get_value() -> DisassociateWorkspaceApplicationResultTypeDef:
    return {
        "Association": ...,
    }


# DisassociateWorkspaceApplicationResultTypeDef definition

class DisassociateWorkspaceApplicationResultTypeDef(TypedDict):
    Association: WorkspaceResourceAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceResourceAssociationTypeDef
  2. See ResponseMetadataTypeDef

WorkSpaceApplicationDeploymentTypeDef#

# WorkSpaceApplicationDeploymentTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkSpaceApplicationDeploymentTypeDef


def get_value() -> WorkSpaceApplicationDeploymentTypeDef:
    return {
        "Associations": ...,
    }


# WorkSpaceApplicationDeploymentTypeDef definition

class WorkSpaceApplicationDeploymentTypeDef(TypedDict):
    Associations: NotRequired[List[WorkspaceResourceAssociationTypeDef]],  # (1)
  1. See List[WorkspaceResourceAssociationTypeDef]

DescribeIpGroupsResultTypeDef#

# DescribeIpGroupsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeIpGroupsResultTypeDef


def get_value() -> DescribeIpGroupsResultTypeDef:
    return {
        "Result": ...,
    }


# DescribeIpGroupsResultTypeDef definition

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

ImportClientBrandingRequestTypeDef#

# ImportClientBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ImportClientBrandingRequestTypeDef


def get_value() -> ImportClientBrandingRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ImportClientBrandingRequestTypeDef definition

class ImportClientBrandingRequestTypeDef(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 TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeClientPropertiesResultTypeDef


def get_value() -> DescribeClientPropertiesResultTypeDef:
    return {
        "ClientPropertiesList": ...,
    }


# DescribeClientPropertiesResultTypeDef definition

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

DescribeConnectionAliasesResultTypeDef#

# DescribeConnectionAliasesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeConnectionAliasesResultTypeDef


def get_value() -> DescribeConnectionAliasesResultTypeDef:
    return {
        "ConnectionAliases": ...,
    }


# DescribeConnectionAliasesResultTypeDef definition

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

FailedCreateStandbyWorkspacesRequestTypeDef#

# FailedCreateStandbyWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import FailedCreateStandbyWorkspacesRequestTypeDef


def get_value() -> FailedCreateStandbyWorkspacesRequestTypeDef:
    return {
        "StandbyWorkspaceRequest": ...,
    }


# FailedCreateStandbyWorkspacesRequestTypeDef definition

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

CreateWorkspaceBundleResultTypeDef#

# CreateWorkspaceBundleResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspaceBundleResultTypeDef


def get_value() -> CreateWorkspaceBundleResultTypeDef:
    return {
        "WorkspaceBundle": ...,
    }


# CreateWorkspaceBundleResultTypeDef definition

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

DescribeWorkspaceBundlesResultTypeDef#

# DescribeWorkspaceBundlesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceBundlesResultTypeDef


def get_value() -> DescribeWorkspaceBundlesResultTypeDef:
    return {
        "Bundles": ...,
    }


# DescribeWorkspaceBundlesResultTypeDef definition

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

WorkspaceRequestOutputTypeDef#

# WorkspaceRequestOutputTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceRequestOutputTypeDef


def get_value() -> WorkspaceRequestOutputTypeDef:
    return {
        "DirectoryId": ...,
    }


# WorkspaceRequestOutputTypeDef definition

class WorkspaceRequestOutputTypeDef(TypedDict):
    DirectoryId: str,
    UserName: str,
    BundleId: str,
    VolumeEncryptionKey: NotRequired[str],
    UserVolumeEncryptionEnabled: NotRequired[bool],
    RootVolumeEncryptionEnabled: NotRequired[bool],
    WorkspaceProperties: NotRequired[WorkspacePropertiesOutputTypeDef],  # (1)
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    WorkspaceName: NotRequired[str],
  1. See WorkspacePropertiesOutputTypeDef
  2. See List[TagTypeDef]

WorkspaceTypeDef#

# WorkspaceTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceTypeDef


def get_value() -> WorkspaceTypeDef:
    return {
        "WorkspaceId": ...,
    }


# 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],
    WorkspaceName: NotRequired[str],
    WorkspaceProperties: NotRequired[WorkspacePropertiesOutputTypeDef],  # (2)
    ModificationStates: NotRequired[List[ModificationStateTypeDef]],  # (3)
    RelatedWorkspaces: NotRequired[List[RelatedWorkspacePropertiesTypeDef]],  # (4)
    DataReplicationSettings: NotRequired[DataReplicationSettingsTypeDef],  # (5)
    StandbyWorkspacesProperties: NotRequired[List[StandbyWorkspacesPropertiesTypeDef]],  # (6)
  1. See WorkspaceStateType
  2. See WorkspacePropertiesOutputTypeDef
  3. See List[ModificationStateTypeDef]
  4. See List[RelatedWorkspacePropertiesTypeDef]
  5. See DataReplicationSettingsTypeDef
  6. See List[StandbyWorkspacesPropertiesTypeDef]

DescribeWorkspacesPoolSessionsResultTypeDef#

# DescribeWorkspacesPoolSessionsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesPoolSessionsResultTypeDef


def get_value() -> DescribeWorkspacesPoolSessionsResultTypeDef:
    return {
        "Sessions": ...,
    }


# DescribeWorkspacesPoolSessionsResultTypeDef definition

class DescribeWorkspacesPoolSessionsResultTypeDef(TypedDict):
    Sessions: List[WorkspacesPoolSessionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[WorkspacesPoolSessionTypeDef]
  2. See ResponseMetadataTypeDef

WorkspaceDirectoryTypeDef#

# WorkspaceDirectoryTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceDirectoryTypeDef


def get_value() -> WorkspaceDirectoryTypeDef:
    return {
        "DirectoryId": ...,
    }


# 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)
    EndpointEncryptionMode: NotRequired[EndpointEncryptionModeType],  # (9)
    MicrosoftEntraConfig: NotRequired[MicrosoftEntraConfigTypeDef],  # (10)
    WorkspaceDirectoryName: NotRequired[str],
    WorkspaceDirectoryDescription: NotRequired[str],
    UserIdentityType: NotRequired[UserIdentityTypeType],  # (11)
    WorkspaceType: NotRequired[WorkspaceTypeType],  # (12)
    IDCConfig: NotRequired[IDCConfigTypeDef],  # (13)
    ActiveDirectoryConfig: NotRequired[ActiveDirectoryConfigTypeDef],  # (14)
    StreamingProperties: NotRequired[StreamingPropertiesOutputTypeDef],  # (15)
    ErrorMessage: NotRequired[str],
  1. See WorkspaceDirectoryTypeType
  2. See WorkspaceDirectoryStateType
  3. See DefaultWorkspaceCreationPropertiesTypeDef
  4. See WorkspaceAccessPropertiesTypeDef
  5. See TenancyType
  6. See SelfservicePermissionsTypeDef
  7. See SamlPropertiesTypeDef
  8. See CertificateBasedAuthPropertiesTypeDef
  9. See EndpointEncryptionModeType
  10. See MicrosoftEntraConfigTypeDef
  11. See UserIdentityTypeType
  12. See WorkspaceTypeType
  13. See IDCConfigTypeDef
  14. See ActiveDirectoryConfigTypeDef
  15. See StreamingPropertiesOutputTypeDef

DescribeWorkspaceImagesResultTypeDef#

# DescribeWorkspaceImagesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceImagesResultTypeDef


def get_value() -> DescribeWorkspaceImagesResultTypeDef:
    return {
        "Images": ...,
    }


# DescribeWorkspaceImagesResultTypeDef definition

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

CreateWorkspacesPoolResultTypeDef#

# CreateWorkspacesPoolResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspacesPoolResultTypeDef


def get_value() -> CreateWorkspacesPoolResultTypeDef:
    return {
        "WorkspacesPool": ...,
    }


# CreateWorkspacesPoolResultTypeDef definition

class CreateWorkspacesPoolResultTypeDef(TypedDict):
    WorkspacesPool: WorkspacesPoolTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspacesPoolTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspacesPoolsResultTypeDef#

# DescribeWorkspacesPoolsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesPoolsResultTypeDef


def get_value() -> DescribeWorkspacesPoolsResultTypeDef:
    return {
        "WorkspacesPools": ...,
    }


# DescribeWorkspacesPoolsResultTypeDef definition

class DescribeWorkspacesPoolsResultTypeDef(TypedDict):
    WorkspacesPools: List[WorkspacesPoolTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[WorkspacesPoolTypeDef]
  2. See ResponseMetadataTypeDef

UpdateWorkspacesPoolResultTypeDef#

# UpdateWorkspacesPoolResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import UpdateWorkspacesPoolResultTypeDef


def get_value() -> UpdateWorkspacesPoolResultTypeDef:
    return {
        "WorkspacesPool": ...,
    }


# UpdateWorkspacesPoolResultTypeDef definition

class UpdateWorkspacesPoolResultTypeDef(TypedDict):
    WorkspacesPool: WorkspacesPoolTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspacesPoolTypeDef
  2. See ResponseMetadataTypeDef

DeployWorkspaceApplicationsResultTypeDef#

# DeployWorkspaceApplicationsResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DeployWorkspaceApplicationsResultTypeDef


def get_value() -> DeployWorkspaceApplicationsResultTypeDef:
    return {
        "Deployment": ...,
    }


# DeployWorkspaceApplicationsResultTypeDef definition

class DeployWorkspaceApplicationsResultTypeDef(TypedDict):
    Deployment: WorkSpaceApplicationDeploymentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkSpaceApplicationDeploymentTypeDef
  2. See ResponseMetadataTypeDef

CreateStandbyWorkspacesResultTypeDef#

# CreateStandbyWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateStandbyWorkspacesResultTypeDef


def get_value() -> CreateStandbyWorkspacesResultTypeDef:
    return {
        "FailedStandbyRequests": ...,
    }


# CreateStandbyWorkspacesResultTypeDef definition

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

CreateStandbyWorkspacesRequestTypeDef#

# CreateStandbyWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateStandbyWorkspacesRequestTypeDef


def get_value() -> CreateStandbyWorkspacesRequestTypeDef:
    return {
        "PrimaryRegion": ...,
    }


# CreateStandbyWorkspacesRequestTypeDef definition

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

FailedCreateWorkspaceRequestTypeDef#

# FailedCreateWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import FailedCreateWorkspaceRequestTypeDef


def get_value() -> FailedCreateWorkspaceRequestTypeDef:
    return {
        "WorkspaceRequest": ...,
    }


# FailedCreateWorkspaceRequestTypeDef definition

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

DescribeWorkspacesResultTypeDef#

# DescribeWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspacesResultTypeDef


def get_value() -> DescribeWorkspacesResultTypeDef:
    return {
        "Workspaces": ...,
    }


# DescribeWorkspacesResultTypeDef definition

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

ModifyWorkspacePropertiesRequestTypeDef#

# ModifyWorkspacePropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyWorkspacePropertiesRequestTypeDef


def get_value() -> ModifyWorkspacePropertiesRequestTypeDef:
    return {
        "WorkspaceId": ...,
    }


# ModifyWorkspacePropertiesRequestTypeDef definition

class ModifyWorkspacePropertiesRequestTypeDef(TypedDict):
    WorkspaceId: str,
    WorkspaceProperties: NotRequired[WorkspacePropertiesUnionTypeDef],  # (1)
    DataReplication: NotRequired[DataReplicationType],  # (2)
  1. See WorkspacePropertiesUnionTypeDef
  2. See DataReplicationType

WorkspaceRequestTypeDef#

# WorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import WorkspaceRequestTypeDef


def get_value() -> WorkspaceRequestTypeDef:
    return {
        "DirectoryId": ...,
    }


# WorkspaceRequestTypeDef definition

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

DescribeWorkspaceDirectoriesResultTypeDef#

# DescribeWorkspaceDirectoriesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import DescribeWorkspaceDirectoriesResultTypeDef


def get_value() -> DescribeWorkspaceDirectoriesResultTypeDef:
    return {
        "Directories": ...,
    }


# DescribeWorkspaceDirectoriesResultTypeDef definition

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

ModifyStreamingPropertiesRequestTypeDef#

# ModifyStreamingPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import ModifyStreamingPropertiesRequestTypeDef


def get_value() -> ModifyStreamingPropertiesRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# ModifyStreamingPropertiesRequestTypeDef definition

class ModifyStreamingPropertiesRequestTypeDef(TypedDict):
    ResourceId: str,
    StreamingProperties: NotRequired[StreamingPropertiesUnionTypeDef],  # (1)
  1. See StreamingPropertiesUnionTypeDef

CreateWorkspacesResultTypeDef#

# CreateWorkspacesResultTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspacesResultTypeDef


def get_value() -> CreateWorkspacesResultTypeDef:
    return {
        "FailedRequests": ...,
    }


# CreateWorkspacesResultTypeDef definition

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

CreateWorkspacesRequestTypeDef#

# CreateWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_workspaces.type_defs import CreateWorkspacesRequestTypeDef


def get_value() -> CreateWorkspacesRequestTypeDef:
    return {
        "Workspaces": ...,
    }


# CreateWorkspacesRequestTypeDef definition

class CreateWorkspacesRequestTypeDef(TypedDict):
    Workspaces: Sequence[WorkspaceRequestUnionTypeDef],  # (1)
  1. See Sequence[WorkspaceRequestUnionTypeDef]