Type definitions#
Index > NimbleStudio > Type definitions
Auto-generated documentation for NimbleStudio type annotations stubs module mypy-boto3-nimble.
AcceptEulasRequestRequestTypeDef#
# AcceptEulasRequestRequestTypeDef definition
class AcceptEulasRequestRequestTypeDef(TypedDict):
studioId: str,
clientToken: NotRequired[str],
eulaIds: NotRequired[Sequence[str]],
EulaAcceptanceTypeDef#
# EulaAcceptanceTypeDef definition
class EulaAcceptanceTypeDef(TypedDict):
acceptedAt: NotRequired[datetime],
acceptedBy: NotRequired[str],
accepteeId: NotRequired[str],
eulaAcceptanceId: NotRequired[str],
eulaId: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ActiveDirectoryComputerAttributeTypeDef#
# ActiveDirectoryComputerAttributeTypeDef definition
class ActiveDirectoryComputerAttributeTypeDef(TypedDict):
name: NotRequired[str],
value: NotRequired[str],
ComputeFarmConfigurationTypeDef#
# ComputeFarmConfigurationTypeDef definition
class ComputeFarmConfigurationTypeDef(TypedDict):
activeDirectoryUser: NotRequired[str],
endpoint: NotRequired[str],
CreateStreamingImageRequestRequestTypeDef#
# CreateStreamingImageRequestRequestTypeDef definition
class CreateStreamingImageRequestRequestTypeDef(TypedDict):
ec2ImageId: str,
name: str,
studioId: str,
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateStreamingSessionRequestRequestTypeDef#
# CreateStreamingSessionRequestRequestTypeDef definition
class CreateStreamingSessionRequestRequestTypeDef(TypedDict):
launchProfileId: str,
studioId: str,
clientToken: NotRequired[str],
ec2InstanceType: NotRequired[StreamingInstanceTypeType], # (1)
ownedBy: NotRequired[str],
streamingImageId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateStreamingSessionStreamRequestRequestTypeDef#
# CreateStreamingSessionStreamRequestRequestTypeDef definition
class CreateStreamingSessionStreamRequestRequestTypeDef(TypedDict):
sessionId: str,
studioId: str,
clientToken: NotRequired[str],
expirationInSeconds: NotRequired[int],
StreamingSessionStreamTypeDef#
# StreamingSessionStreamTypeDef definition
class StreamingSessionStreamTypeDef(TypedDict):
createdAt: NotRequired[datetime],
createdBy: NotRequired[str],
expiresAt: NotRequired[datetime],
ownedBy: NotRequired[str],
state: NotRequired[StreamingSessionStreamStateType], # (1)
statusCode: NotRequired[StreamingSessionStreamStatusCodeType], # (2)
streamId: NotRequired[str],
url: NotRequired[str],
ScriptParameterKeyValueTypeDef#
# ScriptParameterKeyValueTypeDef definition
class ScriptParameterKeyValueTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],
StudioComponentInitializationScriptTypeDef#
# StudioComponentInitializationScriptTypeDef definition
class StudioComponentInitializationScriptTypeDef(TypedDict):
launchProfileProtocolVersion: NotRequired[str],
platform: NotRequired[LaunchProfilePlatformType], # (1)
runContext: NotRequired[StudioComponentInitializationScriptRunContextType], # (2)
script: NotRequired[str],
StudioEncryptionConfigurationTypeDef#
# StudioEncryptionConfigurationTypeDef definition
class StudioEncryptionConfigurationTypeDef(TypedDict):
keyType: StudioEncryptionConfigurationKeyTypeType, # (1)
keyArn: NotRequired[str],
DeleteLaunchProfileMemberRequestRequestTypeDef#
# DeleteLaunchProfileMemberRequestRequestTypeDef definition
class DeleteLaunchProfileMemberRequestRequestTypeDef(TypedDict):
launchProfileId: str,
principalId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteLaunchProfileRequestRequestTypeDef#
# DeleteLaunchProfileRequestRequestTypeDef definition
class DeleteLaunchProfileRequestRequestTypeDef(TypedDict):
launchProfileId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteStreamingImageRequestRequestTypeDef#
# DeleteStreamingImageRequestRequestTypeDef definition
class DeleteStreamingImageRequestRequestTypeDef(TypedDict):
streamingImageId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteStreamingSessionRequestRequestTypeDef#
# DeleteStreamingSessionRequestRequestTypeDef definition
class DeleteStreamingSessionRequestRequestTypeDef(TypedDict):
sessionId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteStudioComponentRequestRequestTypeDef#
# DeleteStudioComponentRequestRequestTypeDef definition
class DeleteStudioComponentRequestRequestTypeDef(TypedDict):
studioComponentId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteStudioMemberRequestRequestTypeDef#
# DeleteStudioMemberRequestRequestTypeDef definition
class DeleteStudioMemberRequestRequestTypeDef(TypedDict):
principalId: str,
studioId: str,
clientToken: NotRequired[str],
DeleteStudioRequestRequestTypeDef#
# DeleteStudioRequestRequestTypeDef definition
class DeleteStudioRequestRequestTypeDef(TypedDict):
studioId: str,
clientToken: NotRequired[str],
EulaTypeDef#
# EulaTypeDef definition
class EulaTypeDef(TypedDict):
content: NotRequired[str],
createdAt: NotRequired[datetime],
eulaId: NotRequired[str],
name: NotRequired[str],
updatedAt: NotRequired[datetime],
GetEulaRequestRequestTypeDef#
# GetEulaRequestRequestTypeDef definition
class GetEulaRequestRequestTypeDef(TypedDict):
eulaId: str,
GetLaunchProfileDetailsRequestRequestTypeDef#
# GetLaunchProfileDetailsRequestRequestTypeDef definition
class GetLaunchProfileDetailsRequestRequestTypeDef(TypedDict):
launchProfileId: str,
studioId: str,
StudioComponentSummaryTypeDef#
# StudioComponentSummaryTypeDef definition
class StudioComponentSummaryTypeDef(TypedDict):
createdAt: NotRequired[datetime],
createdBy: NotRequired[str],
description: NotRequired[str],
name: NotRequired[str],
studioComponentId: NotRequired[str],
subtype: NotRequired[StudioComponentSubtypeType], # (1)
type: NotRequired[StudioComponentTypeType], # (2)
updatedAt: NotRequired[datetime],
updatedBy: NotRequired[str],
GetLaunchProfileInitializationRequestRequestTypeDef#
# GetLaunchProfileInitializationRequestRequestTypeDef definition
class GetLaunchProfileInitializationRequestRequestTypeDef(TypedDict):
launchProfileId: str,
launchProfileProtocolVersions: Sequence[str],
launchPurpose: str,
platform: str,
studioId: str,
GetLaunchProfileMemberRequestRequestTypeDef#
# GetLaunchProfileMemberRequestRequestTypeDef definition
class GetLaunchProfileMemberRequestRequestTypeDef(TypedDict):
launchProfileId: str,
principalId: str,
studioId: str,
LaunchProfileMembershipTypeDef#
# LaunchProfileMembershipTypeDef definition
class LaunchProfileMembershipTypeDef(TypedDict):
identityStoreId: NotRequired[str],
persona: NotRequired[LaunchProfilePersonaType], # (1)
principalId: NotRequired[str],
sid: NotRequired[str],
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
GetLaunchProfileRequestRequestTypeDef#
# GetLaunchProfileRequestRequestTypeDef definition
class GetLaunchProfileRequestRequestTypeDef(TypedDict):
launchProfileId: str,
studioId: str,
GetStreamingImageRequestRequestTypeDef#
# GetStreamingImageRequestRequestTypeDef definition
class GetStreamingImageRequestRequestTypeDef(TypedDict):
streamingImageId: str,
studioId: str,
GetStreamingSessionBackupRequestRequestTypeDef#
# GetStreamingSessionBackupRequestRequestTypeDef definition
class GetStreamingSessionBackupRequestRequestTypeDef(TypedDict):
backupId: str,
studioId: str,
StreamingSessionBackupTypeDef#
# StreamingSessionBackupTypeDef definition
class StreamingSessionBackupTypeDef(TypedDict):
arn: NotRequired[str],
backupId: NotRequired[str],
createdAt: NotRequired[datetime],
launchProfileId: NotRequired[str],
ownedBy: NotRequired[str],
sessionId: NotRequired[str],
state: NotRequired[StreamingSessionStateType], # (1)
statusCode: NotRequired[StreamingSessionStatusCodeType], # (2)
statusMessage: NotRequired[str],
tags: NotRequired[Dict[str, str]],
GetStreamingSessionRequestRequestTypeDef#
# GetStreamingSessionRequestRequestTypeDef definition
class GetStreamingSessionRequestRequestTypeDef(TypedDict):
sessionId: str,
studioId: str,
GetStreamingSessionStreamRequestRequestTypeDef#
# GetStreamingSessionStreamRequestRequestTypeDef definition
class GetStreamingSessionStreamRequestRequestTypeDef(TypedDict):
sessionId: str,
streamId: str,
studioId: str,
GetStudioComponentRequestRequestTypeDef#
# GetStudioComponentRequestRequestTypeDef definition
class GetStudioComponentRequestRequestTypeDef(TypedDict):
studioComponentId: str,
studioId: str,
GetStudioMemberRequestRequestTypeDef#
# GetStudioMemberRequestRequestTypeDef definition
class GetStudioMemberRequestRequestTypeDef(TypedDict):
principalId: str,
studioId: str,
StudioMembershipTypeDef#
# StudioMembershipTypeDef definition
class StudioMembershipTypeDef(TypedDict):
identityStoreId: NotRequired[str],
persona: NotRequired[StudioPersonaType], # (1)
principalId: NotRequired[str],
sid: NotRequired[str],
GetStudioRequestRequestTypeDef#
# GetStudioRequestRequestTypeDef definition
class GetStudioRequestRequestTypeDef(TypedDict):
studioId: str,
LaunchProfileInitializationScriptTypeDef#
# LaunchProfileInitializationScriptTypeDef definition
class LaunchProfileInitializationScriptTypeDef(TypedDict):
runtimeRoleArn: NotRequired[str],
script: NotRequired[str],
secureInitializationRoleArn: NotRequired[str],
studioComponentId: NotRequired[str],
studioComponentName: NotRequired[str],
ValidationResultTypeDef#
# ValidationResultTypeDef definition
class ValidationResultTypeDef(TypedDict):
state: LaunchProfileValidationStateType, # (1)
statusCode: LaunchProfileValidationStatusCodeType, # (2)
statusMessage: str,
type: LaunchProfileValidationTypeType, # (3)
- See LaunchProfileValidationStateType
- See LaunchProfileValidationStatusCodeType
- See LaunchProfileValidationTypeType
LicenseServiceConfigurationTypeDef#
# LicenseServiceConfigurationTypeDef definition
class LicenseServiceConfigurationTypeDef(TypedDict):
endpoint: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListEulaAcceptancesRequestRequestTypeDef#
# ListEulaAcceptancesRequestRequestTypeDef definition
class ListEulaAcceptancesRequestRequestTypeDef(TypedDict):
studioId: str,
eulaIds: NotRequired[Sequence[str]],
nextToken: NotRequired[str],
ListEulasRequestRequestTypeDef#
# ListEulasRequestRequestTypeDef definition
class ListEulasRequestRequestTypeDef(TypedDict):
eulaIds: NotRequired[Sequence[str]],
nextToken: NotRequired[str],
ListLaunchProfileMembersRequestRequestTypeDef#
# ListLaunchProfileMembersRequestRequestTypeDef definition
class ListLaunchProfileMembersRequestRequestTypeDef(TypedDict):
launchProfileId: str,
studioId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListLaunchProfilesRequestRequestTypeDef#
# ListLaunchProfilesRequestRequestTypeDef definition
class ListLaunchProfilesRequestRequestTypeDef(TypedDict):
studioId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
principalId: NotRequired[str],
states: NotRequired[Sequence[LaunchProfileStateType]], # (1)
ListStreamingImagesRequestRequestTypeDef#
# ListStreamingImagesRequestRequestTypeDef definition
class ListStreamingImagesRequestRequestTypeDef(TypedDict):
studioId: str,
nextToken: NotRequired[str],
owner: NotRequired[str],
ListStreamingSessionBackupsRequestRequestTypeDef#
# ListStreamingSessionBackupsRequestRequestTypeDef definition
class ListStreamingSessionBackupsRequestRequestTypeDef(TypedDict):
studioId: str,
nextToken: NotRequired[str],
ownedBy: NotRequired[str],
ListStreamingSessionsRequestRequestTypeDef#
# ListStreamingSessionsRequestRequestTypeDef definition
class ListStreamingSessionsRequestRequestTypeDef(TypedDict):
studioId: str,
createdBy: NotRequired[str],
nextToken: NotRequired[str],
ownedBy: NotRequired[str],
sessionIds: NotRequired[str],
ListStudioComponentsRequestRequestTypeDef#
# ListStudioComponentsRequestRequestTypeDef definition
class ListStudioComponentsRequestRequestTypeDef(TypedDict):
studioId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
states: NotRequired[Sequence[StudioComponentStateType]], # (1)
types: NotRequired[Sequence[StudioComponentTypeType]], # (2)
ListStudioMembersRequestRequestTypeDef#
# ListStudioMembersRequestRequestTypeDef definition
class ListStudioMembersRequestRequestTypeDef(TypedDict):
studioId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListStudiosRequestRequestTypeDef#
# ListStudiosRequestRequestTypeDef definition
class ListStudiosRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
NewLaunchProfileMemberTypeDef#
# NewLaunchProfileMemberTypeDef definition
class NewLaunchProfileMemberTypeDef(TypedDict):
persona: LaunchProfilePersonaType, # (1)
principalId: str,
NewStudioMemberTypeDef#
# NewStudioMemberTypeDef definition
class NewStudioMemberTypeDef(TypedDict):
persona: StudioPersonaType, # (1)
principalId: str,
SharedFileSystemConfigurationTypeDef#
# SharedFileSystemConfigurationTypeDef definition
class SharedFileSystemConfigurationTypeDef(TypedDict):
endpoint: NotRequired[str],
fileSystemId: NotRequired[str],
linuxMountPoint: NotRequired[str],
shareName: NotRequired[str],
windowsMountDrive: NotRequired[str],
StartStreamingSessionRequestRequestTypeDef#
# StartStreamingSessionRequestRequestTypeDef definition
class StartStreamingSessionRequestRequestTypeDef(TypedDict):
sessionId: str,
studioId: str,
backupId: NotRequired[str],
clientToken: NotRequired[str],
StartStudioSSOConfigurationRepairRequestRequestTypeDef#
# StartStudioSSOConfigurationRepairRequestRequestTypeDef definition
class StartStudioSSOConfigurationRepairRequestRequestTypeDef(TypedDict):
studioId: str,
clientToken: NotRequired[str],
StopStreamingSessionRequestRequestTypeDef#
# StopStreamingSessionRequestRequestTypeDef definition
class StopStreamingSessionRequestRequestTypeDef(TypedDict):
sessionId: str,
studioId: str,
clientToken: NotRequired[str],
volumeRetentionMode: NotRequired[VolumeRetentionModeType], # (1)
StreamConfigurationSessionBackupTypeDef#
# StreamConfigurationSessionBackupTypeDef definition
class StreamConfigurationSessionBackupTypeDef(TypedDict):
maxBackupsToRetain: NotRequired[int],
mode: NotRequired[SessionBackupModeType], # (1)
VolumeConfigurationTypeDef#
# VolumeConfigurationTypeDef definition
class VolumeConfigurationTypeDef(TypedDict):
iops: NotRequired[int],
size: NotRequired[int],
throughput: NotRequired[int],
StreamingSessionStorageRootTypeDef#
# StreamingSessionStorageRootTypeDef definition
class StreamingSessionStorageRootTypeDef(TypedDict):
linux: NotRequired[str],
windows: NotRequired[str],
StreamingImageEncryptionConfigurationTypeDef#
# StreamingImageEncryptionConfigurationTypeDef definition
class StreamingImageEncryptionConfigurationTypeDef(TypedDict):
keyType: StreamingImageEncryptionConfigurationKeyTypeType, # (1)
keyArn: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: NotRequired[Mapping[str, str]],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateLaunchProfileMemberRequestRequestTypeDef#
# UpdateLaunchProfileMemberRequestRequestTypeDef definition
class UpdateLaunchProfileMemberRequestRequestTypeDef(TypedDict):
launchProfileId: str,
persona: LaunchProfilePersonaType, # (1)
principalId: str,
studioId: str,
clientToken: NotRequired[str],
UpdateStreamingImageRequestRequestTypeDef#
# UpdateStreamingImageRequestRequestTypeDef definition
class UpdateStreamingImageRequestRequestTypeDef(TypedDict):
streamingImageId: str,
studioId: str,
clientToken: NotRequired[str],
description: NotRequired[str],
name: NotRequired[str],
UpdateStudioRequestRequestTypeDef#
# UpdateStudioRequestRequestTypeDef definition
class UpdateStudioRequestRequestTypeDef(TypedDict):
studioId: str,
adminRoleArn: NotRequired[str],
clientToken: NotRequired[str],
displayName: NotRequired[str],
userRoleArn: NotRequired[str],
AcceptEulasResponseTypeDef#
# AcceptEulasResponseTypeDef definition
class AcceptEulasResponseTypeDef(TypedDict):
eulaAcceptances: List[EulaAcceptanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEulaAcceptancesResponseTypeDef#
# ListEulaAcceptancesResponseTypeDef definition
class ListEulaAcceptancesResponseTypeDef(TypedDict):
eulaAcceptances: List[EulaAcceptanceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ActiveDirectoryConfigurationPaginatorTypeDef#
# ActiveDirectoryConfigurationPaginatorTypeDef definition
class ActiveDirectoryConfigurationPaginatorTypeDef(TypedDict):
computerAttributes: NotRequired[List[ActiveDirectoryComputerAttributeTypeDef]], # (1)
directoryId: NotRequired[str],
organizationalUnitDistinguishedName: NotRequired[str],
ActiveDirectoryConfigurationTypeDef#
# ActiveDirectoryConfigurationTypeDef definition
class ActiveDirectoryConfigurationTypeDef(TypedDict):
computerAttributes: NotRequired[Sequence[ActiveDirectoryComputerAttributeTypeDef]], # (1)
directoryId: NotRequired[str],
organizationalUnitDistinguishedName: NotRequired[str],