types

package
v1.24.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ActiveDirectoryComputerAttribute 

type ActiveDirectoryComputerAttribute struct {

	// The name for the LDAP attribute.
	Name *string

	// The value for the LDAP attribute.
	Value *string
	// contains filtered or unexported fields
}

An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

type ActiveDirectoryConfiguration 

type ActiveDirectoryConfiguration struct {

	// A collection of custom attributes for an Active Directory computer.
	ComputerAttributes []ActiveDirectoryComputerAttribute

	// The directory ID of the Directory Service for Microsoft Active Directory to
	// access using this studio component.
	DirectoryId *string

	// The distinguished name (DN) and organizational unit (OU) of an Active Directory
	// computer.
	OrganizationalUnitDistinguishedName *string
	// contains filtered or unexported fields
}

The configuration for a Directory Service for Microsoft Active Directory studio resource.

type AutomaticTerminationMode added in v1.15.0 

type AutomaticTerminationMode string
const (
	AutomaticTerminationModeDeactivated AutomaticTerminationMode = "DEACTIVATED"
	AutomaticTerminationModeActivated   AutomaticTerminationMode = "ACTIVATED"
)

Enum values for AutomaticTerminationMode

func (AutomaticTerminationMode) Values added in v1.15.0 

func (AutomaticTerminationMode) Values() []AutomaticTerminationMode

Values returns all known values for AutomaticTerminationMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComputeFarmConfiguration 

type ComputeFarmConfiguration struct {

	// The name of an Active Directory user that is used on ComputeFarm worker
	// instances.
	ActiveDirectoryUser *string

	// The endpoint of the ComputeFarm that is accessed by the studio component
	// resource.
	Endpoint *string
	// contains filtered or unexported fields
}

The configuration for a render farm that is associated with a studio resource.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

Another operation is in progress.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Eula 

type Eula struct {

	// The EULA content.
	Content *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The EULA ID.
	EulaId *string

	// The name for the EULA.
	Name *string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Represents a EULA resource.

type EulaAcceptance 

type EulaAcceptance struct {

	// The ISO timestamp in seconds for when the EULA was accepted.
	AcceptedAt *time.Time

	// The ID of the person who accepted the EULA.
	AcceptedBy *string

	// The ID of the acceptee.
	AccepteeId *string

	// The EULA acceptance ID.
	EulaAcceptanceId *string

	// The EULA ID.
	EulaId *string
	// contains filtered or unexported fields
}

The acceptance of a EULA, required to use Amazon-provided streaming images.

type InternalServerErrorException 

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

An internal error has occurred. Please retry your request.

func (*InternalServerErrorException) Error 

func (e *InternalServerErrorException) Error() string

func (*InternalServerErrorException) ErrorCode 

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault 

func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServerErrorException) ErrorMessage 

func (e *InternalServerErrorException) ErrorMessage() string

type LaunchProfile 

type LaunchProfile struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the launch profile.
	CreatedBy *string

	// A human-readable description of the launch profile.
	Description *string

	// Unique identifiers for a collection of EC2 subnets.
	Ec2SubnetIds []string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersions []string

	// A friendly name for the launch profile.
	Name *string

	// The current state.
	State LaunchProfileState

	// The status code.
	StatusCode LaunchProfileStatusCode

	// The status message for the launch profile.
	StatusMessage *string

	// A configuration for a streaming session.
	StreamConfiguration *StreamConfiguration

	// Unique identifiers for a collection of studio components that can be used with
	// this launch profile.
	StudioComponentIds []string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	// The list of the latest validation results.
	ValidationResults []ValidationResult
	// contains filtered or unexported fields
}

A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).

Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.

type LaunchProfileInitialization 

type LaunchProfileInitialization struct {

	// A LaunchProfileInitializationActiveDirectory resource.
	ActiveDirectory *LaunchProfileInitializationActiveDirectory

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersion *string

	// The launch purpose.
	LaunchPurpose *string

	// The name for the launch profile.
	Name *string

	// The platform of the launch platform, either Windows or Linux.
	Platform LaunchProfilePlatform

	// The system initializtion scripts.
	SystemInitializationScripts []LaunchProfileInitializationScript

	// The user initializtion scripts.
	UserInitializationScripts []LaunchProfileInitializationScript
	// contains filtered or unexported fields
}

A launch profile initialization contains information required for a workstation or server to connect to a launch profile.

This includes scripts, endpoints, security groups, subnets, and other configuration.

type LaunchProfileInitializationActiveDirectory 

type LaunchProfileInitializationActiveDirectory struct {

	// A collection of custom attributes for an Active Directory computer.
	ComputerAttributes []ActiveDirectoryComputerAttribute

	// The directory ID of the Directory Service for Microsoft Active Directory to
	// access using this launch profile.
	DirectoryId *string

	// The directory name.
	DirectoryName *string

	// The DNS IP address.
	DnsIpAddresses []string

	// The name for the organizational unit distinguished name.
	OrganizationalUnitDistinguishedName *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The name for the studio component.
	StudioComponentName *string
	// contains filtered or unexported fields
}

The launch profile initialization Active Directory contains information required for the launch profile to connect to the Active Directory.

type LaunchProfileInitializationScript 

type LaunchProfileInitializationScript struct {

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// The initialization script.
	Script *string

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The name for the studio component.
	StudioComponentName *string
	// contains filtered or unexported fields
}

The launch profile initialization script is used when start streaming session runs.

type LaunchProfileMembership 

type LaunchProfileMembership struct {

	// The ID of the identity store.
	IdentityStoreId *string

	// The persona.
	Persona LaunchProfilePersona

	// The principal ID.
	PrincipalId *string

	// The Active Directory Security Identifier for this user, if available.
	Sid *string
	// contains filtered or unexported fields
}

Studio admins can use launch profile membership to delegate launch profile access to studio users in the Nimble Studio portal without writing or maintaining complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.

A launch profile member (type USER) provides the following permissions to that launch profile:

  • GetLaunchProfile

  • GetLaunchProfileInitialization

  • GetLaunchProfileMembers

  • GetLaunchProfileMember

  • CreateStreamingSession

  • GetLaunchProfileDetails

type LaunchProfilePersona 

type LaunchProfilePersona string
const (
	LaunchProfilePersonaUser LaunchProfilePersona = "USER"
)

Enum values for LaunchProfilePersona

func (LaunchProfilePersona) Values 

func (LaunchProfilePersona) Values() []LaunchProfilePersona

Values returns all known values for LaunchProfilePersona. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfilePlatform 

type LaunchProfilePlatform string
const (
	LaunchProfilePlatformLinux   LaunchProfilePlatform = "LINUX"
	LaunchProfilePlatformWindows LaunchProfilePlatform = "WINDOWS"
)

Enum values for LaunchProfilePlatform

func (LaunchProfilePlatform) Values 

func (LaunchProfilePlatform) Values() []LaunchProfilePlatform

Values returns all known values for LaunchProfilePlatform. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfileState 

type LaunchProfileState string
const (
	LaunchProfileStateCreateInProgress LaunchProfileState = "CREATE_IN_PROGRESS"
	LaunchProfileStateReady            LaunchProfileState = "READY"
	LaunchProfileStateUpdateInProgress LaunchProfileState = "UPDATE_IN_PROGRESS"
	LaunchProfileStateDeleteInProgress LaunchProfileState = "DELETE_IN_PROGRESS"
	LaunchProfileStateDeleted          LaunchProfileState = "DELETED"
	LaunchProfileStateDeleteFailed     LaunchProfileState = "DELETE_FAILED"
	LaunchProfileStateCreateFailed     LaunchProfileState = "CREATE_FAILED"
	LaunchProfileStateUpdateFailed     LaunchProfileState = "UPDATE_FAILED"
)

Enum values for LaunchProfileState

func (LaunchProfileState) Values 

func (LaunchProfileState) Values() []LaunchProfileState

Values returns all known values for LaunchProfileState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfileStatusCode 

type LaunchProfileStatusCode string
const (
	LaunchProfileStatusCodeLaunchProfileCreated                      LaunchProfileStatusCode = "LAUNCH_PROFILE_CREATED"
	LaunchProfileStatusCodeLaunchProfileUpdated                      LaunchProfileStatusCode = "LAUNCH_PROFILE_UPDATED"
	LaunchProfileStatusCodeLaunchProfileDeleted                      LaunchProfileStatusCode = "LAUNCH_PROFILE_DELETED"
	LaunchProfileStatusCodeLaunchProfileCreateInProgress             LaunchProfileStatusCode = "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
	LaunchProfileStatusCodeLaunchProfileUpdateInProgress             LaunchProfileStatusCode = "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
	LaunchProfileStatusCodeLaunchProfileDeleteInProgress             LaunchProfileStatusCode = "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
	LaunchProfileStatusCodeInternalError                             LaunchProfileStatusCode = "INTERNAL_ERROR"
	LaunchProfileStatusCodeStreamingImageNotFound                    LaunchProfileStatusCode = "STREAMING_IMAGE_NOT_FOUND"
	LaunchProfileStatusCodeStreamingImageNotReady                    LaunchProfileStatusCode = "STREAMING_IMAGE_NOT_READY"
	LaunchProfileStatusCodeLaunchProfileWithStreamSessionsNotDeleted LaunchProfileStatusCode = "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
	LaunchProfileStatusCodeEncryptionKeyAccessDenied                 LaunchProfileStatusCode = "ENCRYPTION_KEY_ACCESS_DENIED"
	LaunchProfileStatusCodeEncryptionKeyNotFound                     LaunchProfileStatusCode = "ENCRYPTION_KEY_NOT_FOUND"
	LaunchProfileStatusCodeInvalidSubnetsProvided                    LaunchProfileStatusCode = "INVALID_SUBNETS_PROVIDED"
	LaunchProfileStatusCodeInvalidInstanceTypesProvided              LaunchProfileStatusCode = "INVALID_INSTANCE_TYPES_PROVIDED"
	LaunchProfileStatusCodeInvalidSubnetsCombination                 LaunchProfileStatusCode = "INVALID_SUBNETS_COMBINATION"
)

Enum values for LaunchProfileStatusCode

func (LaunchProfileStatusCode) Values 

func (LaunchProfileStatusCode) Values() []LaunchProfileStatusCode

Values returns all known values for LaunchProfileStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfileValidationState added in v1.10.0 

type LaunchProfileValidationState string
const (
	LaunchProfileValidationStateValidationNotStarted                LaunchProfileValidationState = "VALIDATION_NOT_STARTED"
	LaunchProfileValidationStateValidationInProgress                LaunchProfileValidationState = "VALIDATION_IN_PROGRESS"
	LaunchProfileValidationStateValidationSuccess                   LaunchProfileValidationState = "VALIDATION_SUCCESS"
	LaunchProfileValidationStateValidationFailed                    LaunchProfileValidationState = "VALIDATION_FAILED"
	LaunchProfileValidationStateValidationFailedInternalServerError LaunchProfileValidationState = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
)

Enum values for LaunchProfileValidationState

func (LaunchProfileValidationState) Values added in v1.10.0 

func (LaunchProfileValidationState) Values() []LaunchProfileValidationState

Values returns all known values for LaunchProfileValidationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfileValidationStatusCode added in v1.10.0 

type LaunchProfileValidationStatusCode string
const (
	LaunchProfileValidationStatusCodeValidationNotStarted                               LaunchProfileValidationStatusCode = "VALIDATION_NOT_STARTED"
	LaunchProfileValidationStatusCodeValidationInProgress                               LaunchProfileValidationStatusCode = "VALIDATION_IN_PROGRESS"
	LaunchProfileValidationStatusCodeValidationSuccess                                  LaunchProfileValidationStatusCode = "VALIDATION_SUCCESS"
	LaunchProfileValidationStatusCodeValidationFailedInvalidSubnetRouteTableAssociation LaunchProfileValidationStatusCode = "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"
	LaunchProfileValidationStatusCodeValidationFailedSubnetNotFound                     LaunchProfileValidationStatusCode = "VALIDATION_FAILED_SUBNET_NOT_FOUND"
	LaunchProfileValidationStatusCodeValidationFailedInvalidSecurityGroupAssociation    LaunchProfileValidationStatusCode = "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"
	LaunchProfileValidationStatusCodeValidationFailedInvalidActiveDirectory             LaunchProfileValidationStatusCode = "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"
	LaunchProfileValidationStatusCodeValidationFailedUnauthorized                       LaunchProfileValidationStatusCode = "VALIDATION_FAILED_UNAUTHORIZED"
	LaunchProfileValidationStatusCodeValidationFailedInternalServerError                LaunchProfileValidationStatusCode = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
)

Enum values for LaunchProfileValidationStatusCode

func (LaunchProfileValidationStatusCode) Values added in v1.10.0 

func (LaunchProfileValidationStatusCode) Values() []LaunchProfileValidationStatusCode

Values returns all known values for LaunchProfileValidationStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LaunchProfileValidationType added in v1.10.0 

type LaunchProfileValidationType string
const (
	LaunchProfileValidationTypeValidateActiveDirectoryStudioComponent LaunchProfileValidationType = "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
	LaunchProfileValidationTypeValidateSubnetAssociation              LaunchProfileValidationType = "VALIDATE_SUBNET_ASSOCIATION"
	LaunchProfileValidationTypeValidateNetworkAclAssociation          LaunchProfileValidationType = "VALIDATE_NETWORK_ACL_ASSOCIATION"
	LaunchProfileValidationTypeValidateSecurityGroupAssociation       LaunchProfileValidationType = "VALIDATE_SECURITY_GROUP_ASSOCIATION"
)

Enum values for LaunchProfileValidationType

func (LaunchProfileValidationType) Values added in v1.10.0 

func (LaunchProfileValidationType) Values() []LaunchProfileValidationType

Values returns all known values for LaunchProfileValidationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LicenseServiceConfiguration 

type LicenseServiceConfiguration struct {

	// The endpoint of the license service that is accessed by the studio component
	// resource.
	Endpoint *string
	// contains filtered or unexported fields
}

The configuration for a license service that is associated with a studio resource.

type NewLaunchProfileMember 

type NewLaunchProfileMember struct {

	// The persona.
	//
	// This member is required.
	Persona LaunchProfilePersona

	// The principal ID.
	//
	// This member is required.
	PrincipalId *string
	// contains filtered or unexported fields
}

A new member that is added to a launch profile.

type NewStudioMember 

type NewStudioMember struct {

	// The persona.
	//
	// This member is required.
	Persona StudioPersona

	// The principal ID.
	//
	// This member is required.
	PrincipalId *string
	// contains filtered or unexported fields
}

A new studio user's membership.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

The specified resource could not be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ScriptParameterKeyValue 

type ScriptParameterKeyValue struct {

	// A script parameter key.
	Key *string

	// A script parameter value.
	Value *string
	// contains filtered or unexported fields
}

A parameter for a studio component script, in the form of a key-value pair.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SessionBackupMode added in v1.15.0 

type SessionBackupMode string
const (
	SessionBackupModeAutomatic   SessionBackupMode = "AUTOMATIC"
	SessionBackupModeDeactivated SessionBackupMode = "DEACTIVATED"
)

Enum values for SessionBackupMode

func (SessionBackupMode) Values added in v1.15.0 

func (SessionBackupMode) Values() []SessionBackupMode

Values returns all known values for SessionBackupMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionPersistenceMode added in v1.15.0 

type SessionPersistenceMode string
const (
	SessionPersistenceModeDeactivated SessionPersistenceMode = "DEACTIVATED"
	SessionPersistenceModeActivated   SessionPersistenceMode = "ACTIVATED"
)

Enum values for SessionPersistenceMode

func (SessionPersistenceMode) Values added in v1.15.0 

func (SessionPersistenceMode) Values() []SessionPersistenceMode

Values returns all known values for SessionPersistenceMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SharedFileSystemConfiguration 

type SharedFileSystemConfiguration struct {

	// The endpoint of the shared file system that is accessed by the studio component
	// resource.
	Endpoint *string

	// The unique identifier for a file system.
	FileSystemId *string

	// The mount location for a shared file system on a Linux virtual workstation.
	LinuxMountPoint *string

	// The name of the file share.
	ShareName *string

	// The mount location for a shared file system on a Windows virtual workstation.
	WindowsMountDrive *string
	// contains filtered or unexported fields
}

The configuration for a shared file storage system that is associated with a studio resource.

type StreamConfiguration 

type StreamConfiguration struct {

	// Allows or deactivates the use of the system clipboard to copy and paste between
	// the streaming session and streaming client.
	//
	// This member is required.
	ClipboardMode StreamingClipboardMode

	// The EC2 instance types that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	Ec2InstanceTypes []StreamingInstanceType

	// The streaming images that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	StreamingImageIds []string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// The length of time, in minutes, that a streaming session can be active before
	// it is stopped or terminated. After this point, Nimble Studio automatically
	// terminates or stops the session. The default length of time is 690 minutes, and
	// the maximum length of time is 30 days.
	MaxSessionLengthInMinutes *int32

	// Integer that determines if you can start and stop your sessions and how long a
	// session can stay in the STOPPED state. The default value is 0. The maximum
	// value is 5760.
	//
	// This field is allowed only when sessionPersistenceMode is ACTIVATED and
	// automaticTerminationMode is ACTIVATED .
	//
	// If the value is set to 0, your sessions can’t be STOPPED . If you then call
	// StopStreamingSession , the session fails. If the time that a session stays in
	// the READY state exceeds the maxSessionLengthInMinutes value, the session will
	// automatically be terminated (instead of STOPPED ).
	//
	// If the value is set to a positive number, the session can be stopped. You can
	// call StopStreamingSession to stop sessions in the READY state. If the time that
	// a session stays in the READY state exceeds the maxSessionLengthInMinutes value,
	// the session will automatically be stopped (instead of terminated).
	MaxStoppedSessionLengthInMinutes int32

	// Information about the streaming session backup.
	SessionBackup *StreamConfigurationSessionBackup

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The upload storage for a streaming session.
	SessionStorage *StreamConfigurationSessionStorage

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED .
	VolumeConfiguration *VolumeConfiguration
	// contains filtered or unexported fields
}

A configuration for a streaming session.

type StreamConfigurationCreate 

type StreamConfigurationCreate struct {

	// Allows or deactivates the use of the system clipboard to copy and paste between
	// the streaming session and streaming client.
	//
	// This member is required.
	ClipboardMode StreamingClipboardMode

	// The EC2 instance types that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	Ec2InstanceTypes []StreamingInstanceType

	// The streaming images that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	StreamingImageIds []string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// The length of time, in minutes, that a streaming session can be active before
	// it is stopped or terminated. After this point, Nimble Studio automatically
	// terminates or stops the session. The default length of time is 690 minutes, and
	// the maximum length of time is 30 days.
	MaxSessionLengthInMinutes *int32

	// Integer that determines if you can start and stop your sessions and how long a
	// session can stay in the STOPPED state. The default value is 0. The maximum
	// value is 5760.
	//
	// This field is allowed only when sessionPersistenceMode is ACTIVATED and
	// automaticTerminationMode is ACTIVATED .
	//
	// If the value is set to 0, your sessions can’t be STOPPED . If you then call
	// StopStreamingSession , the session fails. If the time that a session stays in
	// the READY state exceeds the maxSessionLengthInMinutes value, the session will
	// automatically be terminated (instead of STOPPED ).
	//
	// If the value is set to a positive number, the session can be stopped. You can
	// call StopStreamingSession to stop sessions in the READY state. If the time that
	// a session stays in the READY state exceeds the maxSessionLengthInMinutes value,
	// the session will automatically be stopped (instead of terminated).
	MaxStoppedSessionLengthInMinutes int32

	// Configures how streaming sessions are backed up when launched from this launch
	// profile.
	SessionBackup *StreamConfigurationSessionBackup

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The upload storage for a streaming workstation that is created using this
	// launch profile.
	SessionStorage *StreamConfigurationSessionStorage

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED .
	VolumeConfiguration *VolumeConfiguration
	// contains filtered or unexported fields
}

Configuration for streaming workstations created using this launch profile.

type StreamConfigurationSessionBackup added in v1.15.0 

type StreamConfigurationSessionBackup struct {

	// The maximum number of backups that each streaming session created from this
	// launch profile can have.
	MaxBackupsToRetain int32

	// Specifies how artists sessions are backed up.
	//
	// Configures backups for streaming sessions launched with this launch profile.
	// The default value is DEACTIVATED , which means that backups are deactivated. To
	// allow backups, set this value to AUTOMATIC .
	Mode SessionBackupMode
	// contains filtered or unexported fields
}

Configures how streaming sessions are backed up when launched from this launch profile.

type StreamConfigurationSessionStorage added in v1.8.0 

type StreamConfigurationSessionStorage struct {

	// Allows artists to upload files to their workstations. The only valid option is
	// UPLOAD .
	//
	// This member is required.
	Mode []StreamingSessionStorageMode

	// The configuration for the upload storage root of the streaming session.
	Root *StreamingSessionStorageRoot
	// contains filtered or unexported fields
}

The configuration for a streaming session’s upload storage.

type StreamingClipboardMode 

type StreamingClipboardMode string
const (
	StreamingClipboardModeEnabled  StreamingClipboardMode = "ENABLED"
	StreamingClipboardModeDisabled StreamingClipboardMode = "DISABLED"
)

Enum values for StreamingClipboardMode

func (StreamingClipboardMode) Values 

func (StreamingClipboardMode) Values() []StreamingClipboardMode

Values returns all known values for StreamingClipboardMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingImage 

type StreamingImage struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// A human-readable description of the streaming image.
	Description *string

	// The ID of an EC2 machine image with which to create the streaming image.
	Ec2ImageId *string

	// The encryption configuration.
	EncryptionConfiguration *StreamingImageEncryptionConfiguration

	// The list of EULAs that must be accepted before a Streaming Session can be
	// started using this streaming image.
	EulaIds []string

	// A friendly name for a streaming image resource.
	Name *string

	// The owner of the streaming image, either the studioId that contains the
	// streaming image, or amazon for images that are provided by Amazon Nimble Studio.
	Owner *string

	// The platform of the streaming image, either Windows or Linux.
	Platform *string

	// The current state.
	State StreamingImageState

	// The status code.
	StatusCode StreamingImageStatusCode

	// The status message for the streaming image.
	StatusMessage *string

	// The ID of the streaming image.
	StreamingImageId *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Represents a streaming image resource.

Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

Amazon provides a number of streaming images that include popular 3rd-party software.

You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.

type StreamingImageEncryptionConfiguration 

type StreamingImageEncryptionConfiguration struct {

	// The type of KMS key that is used to encrypt studio data.
	//
	// This member is required.
	KeyType StreamingImageEncryptionConfigurationKeyType

	// The ARN for a KMS key that is used to encrypt studio data.
	KeyArn *string
	// contains filtered or unexported fields
}

Specifies how a streaming image is encrypted.

type StreamingImageEncryptionConfigurationKeyType 

type StreamingImageEncryptionConfigurationKeyType string
const (
	StreamingImageEncryptionConfigurationKeyTypeCustomerManagedKey StreamingImageEncryptionConfigurationKeyType = "CUSTOMER_MANAGED_KEY"
)

Enum values for StreamingImageEncryptionConfigurationKeyType

func (StreamingImageEncryptionConfigurationKeyType) Values 

func (StreamingImageEncryptionConfigurationKeyType) Values() []StreamingImageEncryptionConfigurationKeyType

Values returns all known values for StreamingImageEncryptionConfigurationKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingImageState 

type StreamingImageState string
const (
	StreamingImageStateCreateInProgress StreamingImageState = "CREATE_IN_PROGRESS"
	StreamingImageStateReady            StreamingImageState = "READY"
	StreamingImageStateDeleteInProgress StreamingImageState = "DELETE_IN_PROGRESS"
	StreamingImageStateDeleted          StreamingImageState = "DELETED"
	StreamingImageStateUpdateInProgress StreamingImageState = "UPDATE_IN_PROGRESS"
	StreamingImageStateUpdateFailed     StreamingImageState = "UPDATE_FAILED"
	StreamingImageStateCreateFailed     StreamingImageState = "CREATE_FAILED"
	StreamingImageStateDeleteFailed     StreamingImageState = "DELETE_FAILED"
)

Enum values for StreamingImageState

func (StreamingImageState) Values 

func (StreamingImageState) Values() []StreamingImageState

Values returns all known values for StreamingImageState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingImageStatusCode 

type StreamingImageStatusCode string
const (
	StreamingImageStatusCodeStreamingImageCreateInProgress StreamingImageStatusCode = "STREAMING_IMAGE_CREATE_IN_PROGRESS"
	StreamingImageStatusCodeStreamingImageReady            StreamingImageStatusCode = "STREAMING_IMAGE_READY"
	StreamingImageStatusCodeStreamingImageDeleteInProgress StreamingImageStatusCode = "STREAMING_IMAGE_DELETE_IN_PROGRESS"
	StreamingImageStatusCodeStreamingImageDeleted          StreamingImageStatusCode = "STREAMING_IMAGE_DELETED"
	StreamingImageStatusCodeStreamingImageUpdateInProgress StreamingImageStatusCode = "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
	StreamingImageStatusCodeInternalError                  StreamingImageStatusCode = "INTERNAL_ERROR"
	StreamingImageStatusCodeAccessDenied                   StreamingImageStatusCode = "ACCESS_DENIED"
)

Enum values for StreamingImageStatusCode

func (StreamingImageStatusCode) Values 

func (StreamingImageStatusCode) Values() []StreamingImageStatusCode

Values returns all known values for StreamingImageStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingInstanceType 

type StreamingInstanceType string
const (
	StreamingInstanceTypeG4dnXlarge   StreamingInstanceType = "g4dn.xlarge"
	StreamingInstanceTypeG4dn2xlarge  StreamingInstanceType = "g4dn.2xlarge"
	StreamingInstanceTypeG4dn4xlarge  StreamingInstanceType = "g4dn.4xlarge"
	StreamingInstanceTypeG4dn8xlarge  StreamingInstanceType = "g4dn.8xlarge"
	StreamingInstanceTypeG4dn12xlarge StreamingInstanceType = "g4dn.12xlarge"
	StreamingInstanceTypeG4dn16xlarge StreamingInstanceType = "g4dn.16xlarge"
	StreamingInstanceTypeG34xlarge    StreamingInstanceType = "g3.4xlarge"
	StreamingInstanceTypeG3sXlarge    StreamingInstanceType = "g3s.xlarge"
	StreamingInstanceTypeG5Xlarge     StreamingInstanceType = "g5.xlarge"
	StreamingInstanceTypeG52xlarge    StreamingInstanceType = "g5.2xlarge"
	StreamingInstanceTypeG54xlarge    StreamingInstanceType = "g5.4xlarge"
	StreamingInstanceTypeG58xlarge    StreamingInstanceType = "g5.8xlarge"
	StreamingInstanceTypeG516xlarge   StreamingInstanceType = "g5.16xlarge"
)

Enum values for StreamingInstanceType

func (StreamingInstanceType) Values 

func (StreamingInstanceType) Values() []StreamingInstanceType

Values returns all known values for StreamingInstanceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingSession 

type StreamingSession struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// Shows the current backup setting of the session.
	BackupMode SessionBackupMode

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the streaming session.
	CreatedBy *string

	// The EC2 Instance type used for the streaming session.
	Ec2InstanceType *string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The maximum number of backups of a streaming session that you can have. When
	// the maximum number of backups is reached, the oldest backup is deleted.
	MaxBackupsToRetain int32

	// The user ID of the user that owns the streaming session. The user that owns the
	// session will be logging into the session and interacting with the virtual
	// workstation.
	OwnedBy *string

	// The session ID.
	SessionId *string

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The time the session entered START_IN_PROGRESS state.
	StartedAt *time.Time

	// The user ID of the user that started the streaming session.
	StartedBy *string

	// The backup ID used to restore a streaming session.
	StartedFromBackupId *string

	// The current state.
	State StreamingSessionState

	// The status code.
	StatusCode StreamingSessionStatusCode

	// The status message for the streaming session.
	StatusMessage *string

	// The time the streaming session will automatically be stopped if the user
	// doesn’t stop the session themselves.
	StopAt *time.Time

	// The time the session entered STOP_IN_PROGRESS state.
	StoppedAt *time.Time

	// The user ID of the user that stopped the streaming session.
	StoppedBy *string

	// The ID of the streaming image.
	StreamingImageId *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The time the streaming session will automatically terminate if not terminated
	// by the user.
	TerminateAt *time.Time

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions.
	//
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED .
	VolumeConfiguration *VolumeConfiguration

	// Determine if an EBS volume created from this streaming session will be backed
	// up.
	VolumeRetentionMode VolumeRetentionMode
	// contains filtered or unexported fields
}

A streaming session is a virtual workstation created using a particular launch profile.

type StreamingSessionBackup added in v1.15.0 

type StreamingSessionBackup struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ID of the backup.
	BackupId *string

	// The ISO timestamp in for when the resource was created.
	CreatedAt *time.Time

	// The ID of the launch profile which allowed the backups for the streaming
	// session.
	LaunchProfileId *string

	// The user ID of the user that owns the streaming session.
	OwnedBy *string

	// The streaming session ID for the StreamingSessionBackup .
	SessionId *string

	// The streaming session state.
	State StreamingSessionState

	// The status code.
	StatusCode StreamingSessionStatusCode

	// The status message for the streaming session backup.
	StatusMessage *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the streaming session backup.

type StreamingSessionState 

type StreamingSessionState string
const (
	StreamingSessionStateCreateInProgress StreamingSessionState = "CREATE_IN_PROGRESS"
	StreamingSessionStateDeleteInProgress StreamingSessionState = "DELETE_IN_PROGRESS"
	StreamingSessionStateReady            StreamingSessionState = "READY"
	StreamingSessionStateDeleted          StreamingSessionState = "DELETED"
	StreamingSessionStateCreateFailed     StreamingSessionState = "CREATE_FAILED"
	StreamingSessionStateDeleteFailed     StreamingSessionState = "DELETE_FAILED"
	StreamingSessionStateStopInProgress   StreamingSessionState = "STOP_IN_PROGRESS"
	StreamingSessionStateStartInProgress  StreamingSessionState = "START_IN_PROGRESS"
	StreamingSessionStateStopped          StreamingSessionState = "STOPPED"
	StreamingSessionStateStopFailed       StreamingSessionState = "STOP_FAILED"
	StreamingSessionStateStartFailed      StreamingSessionState = "START_FAILED"
)

Enum values for StreamingSessionState

func (StreamingSessionState) Values 

func (StreamingSessionState) Values() []StreamingSessionState

Values returns all known values for StreamingSessionState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingSessionStatusCode 

type StreamingSessionStatusCode string
const (
	StreamingSessionStatusCodeStreamingSessionReady            StreamingSessionStatusCode = "STREAMING_SESSION_READY"
	StreamingSessionStatusCodeStreamingSessionDeleted          StreamingSessionStatusCode = "STREAMING_SESSION_DELETED"
	StreamingSessionStatusCodeStreamingSessionCreateInProgress StreamingSessionStatusCode = "STREAMING_SESSION_CREATE_IN_PROGRESS"
	StreamingSessionStatusCodeStreamingSessionDeleteInProgress StreamingSessionStatusCode = "STREAMING_SESSION_DELETE_IN_PROGRESS"
	StreamingSessionStatusCodeInternalError                    StreamingSessionStatusCode = "INTERNAL_ERROR"
	StreamingSessionStatusCodeInsufficientCapacity             StreamingSessionStatusCode = "INSUFFICIENT_CAPACITY"
	StreamingSessionStatusCodeActiveDirectoryDomainJoinError   StreamingSessionStatusCode = "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"
	StreamingSessionStatusCodeNetworkConnectionError           StreamingSessionStatusCode = "NETWORK_CONNECTION_ERROR"
	StreamingSessionStatusCodeInitializationScriptError        StreamingSessionStatusCode = "INITIALIZATION_SCRIPT_ERROR"
	StreamingSessionStatusCodeDecryptStreamingImageError       StreamingSessionStatusCode = "DECRYPT_STREAMING_IMAGE_ERROR"
	StreamingSessionStatusCodeNetworkInterfaceError            StreamingSessionStatusCode = "NETWORK_INTERFACE_ERROR"
	StreamingSessionStatusCodeStreamingSessionStopped          StreamingSessionStatusCode = "STREAMING_SESSION_STOPPED"
	StreamingSessionStatusCodeStreamingSessionStarted          StreamingSessionStatusCode = "STREAMING_SESSION_STARTED"
	StreamingSessionStatusCodeStreamingSessionStopInProgress   StreamingSessionStatusCode = "STREAMING_SESSION_STOP_IN_PROGRESS"
	StreamingSessionStatusCodeStreamingSessionStartInProgress  StreamingSessionStatusCode = "STREAMING_SESSION_START_IN_PROGRESS"
	StreamingSessionStatusCodeAmiValidationError               StreamingSessionStatusCode = "AMI_VALIDATION_ERROR"
)

Enum values for StreamingSessionStatusCode

func (StreamingSessionStatusCode) Values 

func (StreamingSessionStatusCode) Values() []StreamingSessionStatusCode

Values returns all known values for StreamingSessionStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingSessionStorageMode added in v1.8.0 

type StreamingSessionStorageMode string
const (
	StreamingSessionStorageModeUpload StreamingSessionStorageMode = "UPLOAD"
)

Enum values for StreamingSessionStorageMode

func (StreamingSessionStorageMode) Values added in v1.8.0 

func (StreamingSessionStorageMode) Values() []StreamingSessionStorageMode

Values returns all known values for StreamingSessionStorageMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingSessionStorageRoot added in v1.8.0 

type StreamingSessionStorageRoot struct {

	// The folder path in Linux workstations where files are uploaded.
	Linux *string

	// The folder path in Windows workstations where files are uploaded.
	Windows *string
	// contains filtered or unexported fields
}

The upload storage root location (folder) on streaming workstations where files are uploaded.

type StreamingSessionStream 

type StreamingSessionStream struct {

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the streaming session stream.
	CreatedBy *string

	// The ISO timestamp in seconds for when the resource expires.
	ExpiresAt *time.Time

	// The user ID of the user that owns the streaming session. The user that owns the
	// session will be logging into the session and interacting with the virtual
	// workstation.
	OwnedBy *string

	// The current state.
	State StreamingSessionStreamState

	// The streaming session stream status code.
	StatusCode StreamingSessionStreamStatusCode

	// The stream ID.
	StreamId *string

	// The URL to connect to this stream using the DCV client.
	Url *string
	// contains filtered or unexported fields
}

A stream is an active connection to a streaming session, enabling a studio user to control the streaming session using a compatible client. Streaming session streams are compatible with the NICE DCV web client, included in the Nimble Studio portal, or the NICE DCV desktop client.

type StreamingSessionStreamState 

type StreamingSessionStreamState string
const (
	StreamingSessionStreamStateReady            StreamingSessionStreamState = "READY"
	StreamingSessionStreamStateCreateInProgress StreamingSessionStreamState = "CREATE_IN_PROGRESS"
	StreamingSessionStreamStateDeleteInProgress StreamingSessionStreamState = "DELETE_IN_PROGRESS"
	StreamingSessionStreamStateDeleted          StreamingSessionStreamState = "DELETED"
	StreamingSessionStreamStateCreateFailed     StreamingSessionStreamState = "CREATE_FAILED"
	StreamingSessionStreamStateDeleteFailed     StreamingSessionStreamState = "DELETE_FAILED"
)

Enum values for StreamingSessionStreamState

func (StreamingSessionStreamState) Values 

func (StreamingSessionStreamState) Values() []StreamingSessionStreamState

Values returns all known values for StreamingSessionStreamState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamingSessionStreamStatusCode 

type StreamingSessionStreamStatusCode string
const (
	StreamingSessionStreamStatusCodeStreamCreateInProgress StreamingSessionStreamStatusCode = "STREAM_CREATE_IN_PROGRESS"
	StreamingSessionStreamStatusCodeStreamReady            StreamingSessionStreamStatusCode = "STREAM_READY"
	StreamingSessionStreamStatusCodeStreamDeleteInProgress StreamingSessionStreamStatusCode = "STREAM_DELETE_IN_PROGRESS"
	StreamingSessionStreamStatusCodeStreamDeleted          StreamingSessionStreamStatusCode = "STREAM_DELETED"
	StreamingSessionStreamStatusCodeInternalError          StreamingSessionStreamStatusCode = "INTERNAL_ERROR"
	StreamingSessionStreamStatusCodeNetworkConnectionError StreamingSessionStreamStatusCode = "NETWORK_CONNECTION_ERROR"
)

Enum values for StreamingSessionStreamStatusCode

func (StreamingSessionStreamStatusCode) Values 

func (StreamingSessionStreamStatusCode) Values() []StreamingSessionStreamStatusCode

Values returns all known values for StreamingSessionStreamStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Studio 

type Studio struct {

	// The IAM role that studio admins assume when logging in to the Nimble Studio
	// portal.
	AdminRoleArn *string

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// A friendly name for the studio.
	DisplayName *string

	// The Amazon Web Services Region where the studio resource is located.
	HomeRegion *string

	// The IAM Identity Center application client ID used to integrate with IAM
	// Identity Center. This ID allows IAM Identity Center users to log in to Nimble
	// Studio portal.
	SsoClientId *string

	// The current state of the studio resource.
	State StudioState

	// Status codes that provide additional detail on the studio state.
	StatusCode StudioStatusCode

	// Additional detail on the studio state.
	StatusMessage *string

	// Configuration of the encryption method that is used for the studio.
	StudioEncryptionConfiguration *StudioEncryptionConfiguration

	// The unique identifier for a studio resource. In Nimble Studio, all other
	// resources are contained in a studio resource.
	StudioId *string

	// The name of the studio, as included in the URL when accessing it in the Nimble
	// Studio portal.
	StudioName *string

	// The address of the web page for the studio.
	StudioUrl *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The IAM role that studio users assume when logging in to the Nimble Studio
	// portal.
	UserRoleArn *string
	// contains filtered or unexported fields
}

Represents a studio resource.

A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.

When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.

type StudioComponent 

type StudioComponent struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The configuration of the studio component, based on component type.
	Configuration *StudioComponentConfiguration

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the studio component.
	CreatedBy *string

	// A human-readable description for the studio component resource.
	Description *string

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// Initialization scripts for studio components.
	InitializationScripts []StudioComponentInitializationScript

	// A friendly name for the studio component resource.
	Name *string

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// Parameters for the studio component scripts.
	ScriptParameters []ScriptParameterKeyValue

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The current state.
	State StudioComponentState

	// The status code.
	StatusCode StudioComponentStatusCode

	// The status message for the studio component.
	StatusMessage *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The specific subtype of a studio component.
	Subtype StudioComponentSubtype

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The type of the studio component.
	Type StudioComponentType

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.

Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.

type StudioComponentConfiguration 

type StudioComponentConfiguration struct {

	// The configuration for a Directory Service for Microsoft Active Directory studio
	// resource.
	ActiveDirectoryConfiguration *ActiveDirectoryConfiguration

	// The configuration for a render farm that is associated with a studio resource.
	ComputeFarmConfiguration *ComputeFarmConfiguration

	// The configuration for a license service that is associated with a studio
	// resource.
	LicenseServiceConfiguration *LicenseServiceConfiguration

	// The configuration for a shared file storage system that is associated with a
	// studio resource.
	SharedFileSystemConfiguration *SharedFileSystemConfiguration
	// contains filtered or unexported fields
}

The configuration of the studio component, based on component type.

type StudioComponentInitializationScript 

type StudioComponentInitializationScript struct {

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersion *string

	// The platform of the initialization script, either Windows or Linux.
	Platform LaunchProfilePlatform

	// The method to use when running the initialization script.
	RunContext StudioComponentInitializationScriptRunContext

	// The initialization script.
	Script *string
	// contains filtered or unexported fields
}

Initialization scripts for studio components.

type StudioComponentInitializationScriptRunContext 

type StudioComponentInitializationScriptRunContext string
const (
	StudioComponentInitializationScriptRunContextSystemInitialization StudioComponentInitializationScriptRunContext = "SYSTEM_INITIALIZATION"
	StudioComponentInitializationScriptRunContextUserInitialization   StudioComponentInitializationScriptRunContext = "USER_INITIALIZATION"
)

Enum values for StudioComponentInitializationScriptRunContext

func (StudioComponentInitializationScriptRunContext) Values 

func (StudioComponentInitializationScriptRunContext) Values() []StudioComponentInitializationScriptRunContext

Values returns all known values for StudioComponentInitializationScriptRunContext. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioComponentState 

type StudioComponentState string
const (
	StudioComponentStateCreateInProgress StudioComponentState = "CREATE_IN_PROGRESS"
	StudioComponentStateReady            StudioComponentState = "READY"
	StudioComponentStateUpdateInProgress StudioComponentState = "UPDATE_IN_PROGRESS"
	StudioComponentStateDeleteInProgress StudioComponentState = "DELETE_IN_PROGRESS"
	StudioComponentStateDeleted          StudioComponentState = "DELETED"
	StudioComponentStateDeleteFailed     StudioComponentState = "DELETE_FAILED"
	StudioComponentStateCreateFailed     StudioComponentState = "CREATE_FAILED"
	StudioComponentStateUpdateFailed     StudioComponentState = "UPDATE_FAILED"
)

Enum values for StudioComponentState

func (StudioComponentState) Values 

func (StudioComponentState) Values() []StudioComponentState

Values returns all known values for StudioComponentState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioComponentStatusCode 

type StudioComponentStatusCode string
const (
	StudioComponentStatusCodeActiveDirectoryAlreadyExists    StudioComponentStatusCode = "ACTIVE_DIRECTORY_ALREADY_EXISTS"
	StudioComponentStatusCodeStudioComponentCreated          StudioComponentStatusCode = "STUDIO_COMPONENT_CREATED"
	StudioComponentStatusCodeStudioComponentUpdated          StudioComponentStatusCode = "STUDIO_COMPONENT_UPDATED"
	StudioComponentStatusCodeStudioComponentDeleted          StudioComponentStatusCode = "STUDIO_COMPONENT_DELETED"
	StudioComponentStatusCodeEncryptionKeyAccessDenied       StudioComponentStatusCode = "ENCRYPTION_KEY_ACCESS_DENIED"
	StudioComponentStatusCodeEncryptionKeyNotFound           StudioComponentStatusCode = "ENCRYPTION_KEY_NOT_FOUND"
	StudioComponentStatusCodeStudioComponentCreateInProgress StudioComponentStatusCode = "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
	StudioComponentStatusCodeStudioComponentUpdateInProgress StudioComponentStatusCode = "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
	StudioComponentStatusCodeStudioComponentDeleteInProgress StudioComponentStatusCode = "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
	StudioComponentStatusCodeInternalError                   StudioComponentStatusCode = "INTERNAL_ERROR"
)

Enum values for StudioComponentStatusCode

func (StudioComponentStatusCode) Values 

func (StudioComponentStatusCode) Values() []StudioComponentStatusCode

Values returns all known values for StudioComponentStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioComponentSubtype 

type StudioComponentSubtype string
const (
	StudioComponentSubtypeAwsManagedMicrosoftAd StudioComponentSubtype = "AWS_MANAGED_MICROSOFT_AD"
	StudioComponentSubtypeAmazonFsxForWindows   StudioComponentSubtype = "AMAZON_FSX_FOR_WINDOWS"
	StudioComponentSubtypeAmazonFsxForLustre    StudioComponentSubtype = "AMAZON_FSX_FOR_LUSTRE"
	StudioComponentSubtypeCustom                StudioComponentSubtype = "CUSTOM"
)

Enum values for StudioComponentSubtype

func (StudioComponentSubtype) Values 

func (StudioComponentSubtype) Values() []StudioComponentSubtype

Values returns all known values for StudioComponentSubtype. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioComponentSummary 

type StudioComponentSummary struct {

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the studio component.
	CreatedBy *string

	// The description.
	Description *string

	// The name for the studio component.
	Name *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The specific subtype of a studio component.
	Subtype StudioComponentSubtype

	// The type of the studio component.
	Type StudioComponentType

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The studio component's summary.

type StudioComponentType 

type StudioComponentType string
const (
	StudioComponentTypeActiveDirectory  StudioComponentType = "ACTIVE_DIRECTORY"
	StudioComponentTypeSharedFileSystem StudioComponentType = "SHARED_FILE_SYSTEM"
	StudioComponentTypeComputeFarm      StudioComponentType = "COMPUTE_FARM"
	StudioComponentTypeLicenseService   StudioComponentType = "LICENSE_SERVICE"
	StudioComponentTypeCustom           StudioComponentType = "CUSTOM"
)

Enum values for StudioComponentType

func (StudioComponentType) Values 

func (StudioComponentType) Values() []StudioComponentType

Values returns all known values for StudioComponentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioEncryptionConfiguration 

type StudioEncryptionConfiguration struct {

	// The type of KMS key that is used to encrypt studio data.
	//
	// This member is required.
	KeyType StudioEncryptionConfigurationKeyType

	// The ARN for a KMS key that is used to encrypt studio data.
	KeyArn *string
	// contains filtered or unexported fields
}

Configuration of the encryption method that is used for the studio.

type StudioEncryptionConfigurationKeyType 

type StudioEncryptionConfigurationKeyType string
const (
	StudioEncryptionConfigurationKeyTypeAwsOwnedKey        StudioEncryptionConfigurationKeyType = "AWS_OWNED_KEY"
	StudioEncryptionConfigurationKeyTypeCustomerManagedKey StudioEncryptionConfigurationKeyType = "CUSTOMER_MANAGED_KEY"
)

Enum values for StudioEncryptionConfigurationKeyType

func (StudioEncryptionConfigurationKeyType) Values 

func (StudioEncryptionConfigurationKeyType) Values() []StudioEncryptionConfigurationKeyType

Values returns all known values for StudioEncryptionConfigurationKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioMembership 

type StudioMembership struct {

	// The ID of the identity store.
	IdentityStoreId *string

	// The persona.
	Persona StudioPersona

	// The principal ID.
	PrincipalId *string

	// The Active Directory Security Identifier for this user, if available.
	Sid *string
	// contains filtered or unexported fields
}

A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.

When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.

When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.

type StudioPersona 

type StudioPersona string
const (
	StudioPersonaAdministrator StudioPersona = "ADMINISTRATOR"
)

Enum values for StudioPersona

func (StudioPersona) Values 

func (StudioPersona) Values() []StudioPersona

Values returns all known values for StudioPersona. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioState 

type StudioState string
const (
	StudioStateCreateInProgress StudioState = "CREATE_IN_PROGRESS"
	StudioStateReady            StudioState = "READY"
	StudioStateUpdateInProgress StudioState = "UPDATE_IN_PROGRESS"
	StudioStateDeleteInProgress StudioState = "DELETE_IN_PROGRESS"
	StudioStateDeleted          StudioState = "DELETED"
	StudioStateDeleteFailed     StudioState = "DELETE_FAILED"
	StudioStateCreateFailed     StudioState = "CREATE_FAILED"
	StudioStateUpdateFailed     StudioState = "UPDATE_FAILED"
)

Enum values for StudioState

func (StudioState) Values 

func (StudioState) Values() []StudioState

Values returns all known values for StudioState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StudioStatusCode 

type StudioStatusCode string
const (
	StudioStatusCodeStudioCreated                        StudioStatusCode = "STUDIO_CREATED"
	StudioStatusCodeStudioDeleted                        StudioStatusCode = "STUDIO_DELETED"
	StudioStatusCodeStudioUpdated                        StudioStatusCode = "STUDIO_UPDATED"
	StudioStatusCodeStudioCreateInProgress               StudioStatusCode = "STUDIO_CREATE_IN_PROGRESS"
	StudioStatusCodeStudioUpdateInProgress               StudioStatusCode = "STUDIO_UPDATE_IN_PROGRESS"
	StudioStatusCodeStudioDeleteInProgress               StudioStatusCode = "STUDIO_DELETE_IN_PROGRESS"
	StudioStatusCodeStudioWithLaunchProfilesNotDeleted   StudioStatusCode = "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
	StudioStatusCodeStudioWithStudioComponentsNotDeleted StudioStatusCode = "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
	StudioStatusCodeStudioWithStreamingImagesNotDeleted  StudioStatusCode = "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
	StudioStatusCodeAwsSsoNotEnabled                     StudioStatusCode = "AWS_SSO_NOT_ENABLED"
	StudioStatusCodeAwsSsoAccessDenied                   StudioStatusCode = "AWS_SSO_ACCESS_DENIED"
	StudioStatusCodeRoleNotOwnedByStudioOwner            StudioStatusCode = "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
	StudioStatusCodeRoleCouldNotBeAssumed                StudioStatusCode = "ROLE_COULD_NOT_BE_ASSUMED"
	StudioStatusCodeInternalError                        StudioStatusCode = "INTERNAL_ERROR"
	StudioStatusCodeEncryptionKeyNotFound                StudioStatusCode = "ENCRYPTION_KEY_NOT_FOUND"
	StudioStatusCodeEncryptionKeyAccessDenied            StudioStatusCode = "ENCRYPTION_KEY_ACCESS_DENIED"
	StudioStatusCodeAwsSsoConfigurationRepaired          StudioStatusCode = "AWS_SSO_CONFIGURATION_REPAIRED"
	StudioStatusCodeAwsSsoConfigurationRepairInProgress  StudioStatusCode = "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
	StudioStatusCodeAwsStsRegionDisabled                 StudioStatusCode = "AWS_STS_REGION_DISABLED"
)

Enum values for StudioStatusCode

func (StudioStatusCode) Values 

func (StudioStatusCode) Values() []StudioStatusCode

Values returns all known values for StudioStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

The request throughput limit was exceeded.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Code    *string
	Context map[string]string
	// contains filtered or unexported fields
}

One of the parameters in the request is invalid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationResult added in v1.10.0 

type ValidationResult struct {

	// The current state.
	//
	// This member is required.
	State LaunchProfileValidationState

	// The status code. This will contain the failure reason if the state is
	// VALIDATION_FAILED .
	//
	// This member is required.
	StatusCode LaunchProfileValidationStatusCode

	// The status message for the validation result.
	//
	// This member is required.
	StatusMessage *string

	// The type of the validation result.
	//
	// This member is required.
	Type LaunchProfileValidationType
	// contains filtered or unexported fields
}

The launch profile validation result.

type VolumeConfiguration added in v1.15.0 

type VolumeConfiguration struct {

	// The number of I/O operations per second for the root volume that is attached to
	// streaming session.
	Iops *int32

	// The size of the root volume that is attached to the streaming session. The root
	// volume size is measured in GiBs.
	Size *int32

	// The throughput to provision for the root volume that is attached to the
	// streaming session. The throughput is measured in MiB/s.
	Throughput *int32
	// contains filtered or unexported fields
}

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

type VolumeRetentionMode added in v1.15.0 

type VolumeRetentionMode string
const (
	VolumeRetentionModeRetain VolumeRetentionMode = "RETAIN"
	VolumeRetentionModeDelete VolumeRetentionMode = "DELETE"
)

Enum values for VolumeRetentionMode

func (VolumeRetentionMode) Values added in v1.15.0 

func (VolumeRetentionMode) Values() []VolumeRetentionMode

Values returns all known values for VolumeRetentionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.