import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class Nimble extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: Nimble.Types.ClientConfiguration) config: Config & Nimble.Types.ClientConfiguration; /** * Accept EULAs. */ acceptEulas(params: Nimble.Types.AcceptEulasRequest, callback?: (err: AWSError, data: Nimble.Types.AcceptEulasResponse) => void): Request; /** * Accept EULAs. */ acceptEulas(callback?: (err: AWSError, data: Nimble.Types.AcceptEulasResponse) => void): Request; /** * Create a launch profile. */ createLaunchProfile(params: Nimble.Types.CreateLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.CreateLaunchProfileResponse) => void): Request; /** * Create a launch profile. */ createLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.CreateLaunchProfileResponse) => void): Request; /** * Creates a streaming image resource in a studio. */ createStreamingImage(params: Nimble.Types.CreateStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingImageResponse) => void): Request; /** * Creates a streaming image resource in a studio. */ createStreamingImage(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingImageResponse) => void): Request; /** * Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY. */ createStreamingSession(params: Nimble.Types.CreateStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionResponse) => void): Request; /** * Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY. */ createStreamingSession(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionResponse) => void): Request; /** * Creates a streaming session stream for a streaming session. After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY. */ createStreamingSessionStream(params: Nimble.Types.CreateStreamingSessionStreamRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionStreamResponse) => void): Request; /** * Creates a streaming session stream for a streaming session. After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY. */ createStreamingSessionStream(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionStreamResponse) => void): Request; /** * Create a new Studio. When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal. 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. You may optionally specify a KMS key in the StudioEncryptionConfiguration. In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage. When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio KMS key, your studio will no longer be accessible. */ createStudio(params: Nimble.Types.CreateStudioRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStudioResponse) => void): Request; /** * Create a new Studio. When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal. 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. You may optionally specify a KMS key in the StudioEncryptionConfiguration. In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage. When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio KMS key, your studio will no longer be accessible. */ createStudio(callback?: (err: AWSError, data: Nimble.Types.CreateStudioResponse) => void): Request; /** * Creates a studio component resource. */ createStudioComponent(params: Nimble.Types.CreateStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStudioComponentResponse) => void): Request; /** * Creates a studio component resource. */ createStudioComponent(callback?: (err: AWSError, data: Nimble.Types.CreateStudioComponentResponse) => void): Request; /** * Permanently delete a launch profile. */ deleteLaunchProfile(params: Nimble.Types.DeleteLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileResponse) => void): Request; /** * Permanently delete a launch profile. */ deleteLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileResponse) => void): Request; /** * Delete a user from launch profile membership. */ deleteLaunchProfileMember(params: Nimble.Types.DeleteLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileMemberResponse) => void): Request; /** * Delete a user from launch profile membership. */ deleteLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileMemberResponse) => void): Request; /** * Delete streaming image. */ deleteStreamingImage(params: Nimble.Types.DeleteStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingImageResponse) => void): Request; /** * Delete streaming image. */ deleteStreamingImage(callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingImageResponse) => void): Request; /** * Deletes streaming session resource. After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state. A streaming session will count against your streaming session quota until it is marked DELETED. */ deleteStreamingSession(params: Nimble.Types.DeleteStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingSessionResponse) => void): Request; /** * Deletes streaming session resource. After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state. A streaming session will count against your streaming session quota until it is marked DELETED. */ deleteStreamingSession(callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingSessionResponse) => void): Request; /** * Delete a studio resource. */ deleteStudio(params: Nimble.Types.DeleteStudioRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioResponse) => void): Request; /** * Delete a studio resource. */ deleteStudio(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioResponse) => void): Request; /** * Deletes a studio component resource. */ deleteStudioComponent(params: Nimble.Types.DeleteStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioComponentResponse) => void): Request; /** * Deletes a studio component resource. */ deleteStudioComponent(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioComponentResponse) => void): Request; /** * Delete a user from studio membership. */ deleteStudioMember(params: Nimble.Types.DeleteStudioMemberRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioMemberResponse) => void): Request; /** * Delete a user from studio membership. */ deleteStudioMember(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioMemberResponse) => void): Request; /** * Get Eula. */ getEula(params: Nimble.Types.GetEulaRequest, callback?: (err: AWSError, data: Nimble.Types.GetEulaResponse) => void): Request; /** * Get Eula. */ getEula(callback?: (err: AWSError, data: Nimble.Types.GetEulaResponse) => void): Request; /** * Get a launch profile. */ getLaunchProfile(params: Nimble.Types.GetLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request; /** * Get a launch profile. */ getLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request; /** * Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile. */ getLaunchProfileDetails(params: Nimble.Types.GetLaunchProfileDetailsRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileDetailsResponse) => void): Request; /** * Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile. */ getLaunchProfileDetails(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileDetailsResponse) => void): Request; /** * Get a launch profile initialization. */ getLaunchProfileInitialization(params: Nimble.Types.GetLaunchProfileInitializationRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileInitializationResponse) => void): Request; /** * Get a launch profile initialization. */ getLaunchProfileInitialization(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileInitializationResponse) => void): Request; /** * Get a user persona in launch profile membership. */ getLaunchProfileMember(params: Nimble.Types.GetLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileMemberResponse) => void): Request; /** * Get a user persona in launch profile membership. */ getLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileMemberResponse) => void): Request; /** * Get streaming image. */ getStreamingImage(params: Nimble.Types.GetStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request; /** * Get streaming image. */ getStreamingImage(callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request; /** * Gets StreamingSession resource. Invoke this operation to poll for a streaming session state while creating or deleting a session. */ getStreamingSession(params: Nimble.Types.GetStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request; /** * Gets StreamingSession resource. Invoke this operation to poll for a streaming session state while creating or deleting a session. */ getStreamingSession(callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request; /** * Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client. */ getStreamingSessionStream(params: Nimble.Types.GetStreamingSessionStreamRequest, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionStreamResponse) => void): Request; /** * Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client. */ getStreamingSessionStream(callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionStreamResponse) => void): Request; /** * Get a Studio resource. */ getStudio(params: Nimble.Types.GetStudioRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request; /** * Get a Studio resource. */ getStudio(callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request; /** * Gets a studio component resource. */ getStudioComponent(params: Nimble.Types.GetStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request; /** * Gets a studio component resource. */ getStudioComponent(callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request; /** * Get a user's membership in a studio. */ getStudioMember(params: Nimble.Types.GetStudioMemberRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioMemberResponse) => void): Request; /** * Get a user's membership in a studio. */ getStudioMember(callback?: (err: AWSError, data: Nimble.Types.GetStudioMemberResponse) => void): Request; /** * List Eula Acceptances. */ listEulaAcceptances(params: Nimble.Types.ListEulaAcceptancesRequest, callback?: (err: AWSError, data: Nimble.Types.ListEulaAcceptancesResponse) => void): Request; /** * List Eula Acceptances. */ listEulaAcceptances(callback?: (err: AWSError, data: Nimble.Types.ListEulaAcceptancesResponse) => void): Request; /** * List Eulas. */ listEulas(params: Nimble.Types.ListEulasRequest, callback?: (err: AWSError, data: Nimble.Types.ListEulasResponse) => void): Request; /** * List Eulas. */ listEulas(callback?: (err: AWSError, data: Nimble.Types.ListEulasResponse) => void): Request; /** * Get all users in a given launch profile membership. */ listLaunchProfileMembers(params: Nimble.Types.ListLaunchProfileMembersRequest, callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfileMembersResponse) => void): Request; /** * Get all users in a given launch profile membership. */ listLaunchProfileMembers(callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfileMembersResponse) => void): Request; /** * List all the launch profiles a studio. */ listLaunchProfiles(params: Nimble.Types.ListLaunchProfilesRequest, callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfilesResponse) => void): Request; /** * List all the launch profiles a studio. */ listLaunchProfiles(callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfilesResponse) => void): Request; /** * List the streaming image resources available to this studio. This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio. */ listStreamingImages(params: Nimble.Types.ListStreamingImagesRequest, callback?: (err: AWSError, data: Nimble.Types.ListStreamingImagesResponse) => void): Request; /** * List the streaming image resources available to this studio. This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio. */ listStreamingImages(callback?: (err: AWSError, data: Nimble.Types.ListStreamingImagesResponse) => void): Request; /** * Lists the streaming image resources in a studio. */ listStreamingSessions(params: Nimble.Types.ListStreamingSessionsRequest, callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionsResponse) => void): Request; /** * Lists the streaming image resources in a studio. */ listStreamingSessions(callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionsResponse) => void): Request; /** * Lists the StudioComponents in a studio. */ listStudioComponents(params: Nimble.Types.ListStudioComponentsRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudioComponentsResponse) => void): Request; /** * Lists the StudioComponents in a studio. */ listStudioComponents(callback?: (err: AWSError, data: Nimble.Types.ListStudioComponentsResponse) => void): Request; /** * Get all users in a given studio membership. */ listStudioMembers(params: Nimble.Types.ListStudioMembersRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudioMembersResponse) => void): Request; /** * Get all users in a given studio membership. */ listStudioMembers(callback?: (err: AWSError, data: Nimble.Types.ListStudioMembersResponse) => void): Request; /** * List studios in your Amazon Web Services account in the requested Amazon Web Services Region. */ listStudios(params: Nimble.Types.ListStudiosRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudiosResponse) => void): Request; /** * List studios in your Amazon Web Services account in the requested Amazon Web Services Region. */ listStudios(callback?: (err: AWSError, data: Nimble.Types.ListStudiosResponse) => void): Request; /** * Gets the tags for a resource, given its Amazon Resource Names (ARN). This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself. */ listTagsForResource(params: Nimble.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Nimble.Types.ListTagsForResourceResponse) => void): Request; /** * Gets the tags for a resource, given its Amazon Resource Names (ARN). This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself. */ listTagsForResource(callback?: (err: AWSError, data: Nimble.Types.ListTagsForResourceResponse) => void): Request; /** * Add/update users with given persona to launch profile membership. */ putLaunchProfileMembers(params: Nimble.Types.PutLaunchProfileMembersRequest, callback?: (err: AWSError, data: Nimble.Types.PutLaunchProfileMembersResponse) => void): Request; /** * Add/update users with given persona to launch profile membership. */ putLaunchProfileMembers(callback?: (err: AWSError, data: Nimble.Types.PutLaunchProfileMembersResponse) => void): Request; /** * Add/update users with given persona to studio membership. */ putStudioMembers(params: Nimble.Types.PutStudioMembersRequest, callback?: (err: AWSError, data: Nimble.Types.PutStudioMembersResponse) => void): Request; /** * Add/update users with given persona to studio membership. */ putStudioMembers(callback?: (err: AWSError, data: Nimble.Types.PutStudioMembersResponse) => void): Request; /** * Repairs the SSO configuration for a given studio. If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state. After the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio. */ startStudioSSOConfigurationRepair(params: Nimble.Types.StartStudioSSOConfigurationRepairRequest, callback?: (err: AWSError, data: Nimble.Types.StartStudioSSOConfigurationRepairResponse) => void): Request; /** * Repairs the SSO configuration for a given studio. If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state. After the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio. */ startStudioSSOConfigurationRepair(callback?: (err: AWSError, data: Nimble.Types.StartStudioSSOConfigurationRepairResponse) => void): Request; /** * Creates tags for a resource, given its ARN. */ tagResource(params: Nimble.Types.TagResourceRequest, callback?: (err: AWSError, data: Nimble.Types.TagResourceResponse) => void): Request; /** * Creates tags for a resource, given its ARN. */ tagResource(callback?: (err: AWSError, data: Nimble.Types.TagResourceResponse) => void): Request; /** * Deletes the tags for a resource. */ untagResource(params: Nimble.Types.UntagResourceRequest, callback?: (err: AWSError, data: Nimble.Types.UntagResourceResponse) => void): Request; /** * Deletes the tags for a resource. */ untagResource(callback?: (err: AWSError, data: Nimble.Types.UntagResourceResponse) => void): Request; /** * Update a launch profile. */ updateLaunchProfile(params: Nimble.Types.UpdateLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileResponse) => void): Request; /** * Update a launch profile. */ updateLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileResponse) => void): Request; /** * Update a user persona in launch profile membership. */ updateLaunchProfileMember(params: Nimble.Types.UpdateLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileMemberResponse) => void): Request; /** * Update a user persona in launch profile membership. */ updateLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileMemberResponse) => void): Request; /** * Update streaming image. */ updateStreamingImage(params: Nimble.Types.UpdateStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateStreamingImageResponse) => void): Request; /** * Update streaming image. */ updateStreamingImage(callback?: (err: AWSError, data: Nimble.Types.UpdateStreamingImageResponse) => void): Request; /** * Update a Studio resource. Currently, this operation only supports updating the displayName of your studio. */ updateStudio(params: Nimble.Types.UpdateStudioRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateStudioResponse) => void): Request; /** * Update a Studio resource. Currently, this operation only supports updating the displayName of your studio. */ updateStudio(callback?: (err: AWSError, data: Nimble.Types.UpdateStudioResponse) => void): Request; /** * Updates a studio component resource. */ updateStudioComponent(params: Nimble.Types.UpdateStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateStudioComponentResponse) => void): Request; /** * Updates a studio component resource. */ updateStudioComponent(callback?: (err: AWSError, data: Nimble.Types.UpdateStudioComponentResponse) => void): Request; } declare namespace Nimble { export interface AcceptEulasRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The EULA ID. */ eulaIds?: EulaIdList; /** * The studio ID. */ studioId: __string; } export interface AcceptEulasResponse { /** * A collection of EULA acceptances. */ eulaAcceptances?: EulaAcceptanceList; } export interface ActiveDirectoryComputerAttribute { /** * The name for the LDAP attribute. */ name?: ActiveDirectoryComputerAttributeName; /** * The value for the LDAP attribute. */ value?: ActiveDirectoryComputerAttributeValue; } export type ActiveDirectoryComputerAttributeList = ActiveDirectoryComputerAttribute[]; export type ActiveDirectoryComputerAttributeName = string; export type ActiveDirectoryComputerAttributeValue = string; export interface ActiveDirectoryConfiguration { /** * A collection of custom attributes for an Active Directory computer. */ computerAttributes?: ActiveDirectoryComputerAttributeList; /** * The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component. */ directoryId?: DirectoryId; /** * The distinguished name (DN) and organizational unit (OU) of an Active Directory computer. */ organizationalUnitDistinguishedName?: ActiveDirectoryOrganizationalUnitDistinguishedName; } export type ActiveDirectoryDnsIpAddress = string; export type ActiveDirectoryDnsIpAddressList = ActiveDirectoryDnsIpAddress[]; export type ActiveDirectoryOrganizationalUnitDistinguishedName = string; export interface ComputeFarmConfiguration { /** * 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; } export interface CreateLaunchProfileRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The description. */ description?: LaunchProfileDescription; ec2SubnetIds: EC2SubnetIdList; /** * The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31". */ launchProfileProtocolVersions: LaunchProfileProtocolVersionList; /** * The name for the launch profile. */ name: LaunchProfileName; /** * A configuration for a streaming session. */ streamConfiguration: StreamConfigurationCreate; /** * Unique identifiers for a collection of studio components that can be used with this launch profile. */ studioComponentIds: LaunchProfileStudioComponentIdList; /** * The studio ID. */ studioId: __string; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export interface CreateLaunchProfileResponse { /** * The launch profile. */ launchProfile?: LaunchProfile; } export interface CreateStreamingImageRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * A human-readable description of the streaming image. */ description?: StreamingImageDescription; /** * The ID of an EC2 machine image with which to create this streaming image. */ ec2ImageId: EC2ImageId; /** * A friendly name for a streaming image resource. */ name: StreamingImageName; /** * The studio ID. */ studioId: __string; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export interface CreateStreamingImageResponse { streamingImage?: StreamingImage; } export interface CreateStreamingSessionRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The EC2 Instance type used for the streaming session. */ ec2InstanceType?: StreamingInstanceType; /** * The launch profile ID. */ launchProfileId?: __string; /** * The user ID of the user that owns the streaming session. */ ownedBy?: __string; /** * The ID of the streaming image. */ streamingImageId?: StreamingImageId; /** * The studio ID. */ studioId: __string; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export interface CreateStreamingSessionResponse { /** * The session. */ session?: StreamingSession; } export interface CreateStreamingSessionStreamRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The expiration time in seconds. */ expirationInSeconds?: StreamingSessionStreamExpirationInSeconds; /** * The session ID. */ sessionId: __string; /** * The studio ID. */ studioId: __string; } export interface CreateStreamingSessionStreamResponse { /** * The stream. */ stream?: StreamingSessionStream; } export interface CreateStudioComponentRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The configuration of the studio component, based on component type. */ configuration?: StudioComponentConfiguration; /** * The description. */ description?: StudioComponentDescription; /** * The EC2 security groups that control access to the studio component. */ ec2SecurityGroupIds?: StudioComponentSecurityGroupIdList; /** * Initialization scripts for studio components. */ initializationScripts?: StudioComponentInitializationScriptList; /** * The name for the studio component. */ name: StudioComponentName; /** * Parameters for the studio component scripts. */ scriptParameters?: StudioComponentScriptParameterKeyValueList; /** * The studio ID. */ studioId: __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?: Tags; /** * The type of the studio component. */ type: StudioComponentType; } export interface CreateStudioComponentResponse { /** * Information about the studio component. */ studioComponent?: StudioComponent; } export interface CreateStudioRequest { /** * The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal. */ adminRoleArn: __string; /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * A friendly name for the studio. */ displayName: StudioDisplayName; /** * The studio encryption configuration. */ studioEncryptionConfiguration?: StudioEncryptionConfiguration; /** * The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users. */ studioName: StudioName; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; /** * The IAM role that Studio Users will assume when logging in to the Nimble Studio portal. */ userRoleArn: __string; } export interface CreateStudioResponse { /** * Information about a studio. */ studio?: Studio; } export interface DeleteLaunchProfileMemberRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The launch profile ID. */ launchProfileId: __string; /** * The principal ID. */ principalId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteLaunchProfileMemberResponse { } export interface DeleteLaunchProfileRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The launch profile ID. */ launchProfileId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteLaunchProfileResponse { /** * The launch profile. */ launchProfile?: LaunchProfile; } export interface DeleteStreamingImageRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The streaming image ID. */ streamingImageId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteStreamingImageResponse { /** * The streaming image. */ streamingImage?: StreamingImage; } export interface DeleteStreamingSessionRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The session ID. */ sessionId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteStreamingSessionResponse { /** * The session. */ session?: StreamingSession; } export interface DeleteStudioComponentRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The studio component ID. */ studioComponentId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteStudioComponentResponse { /** * Information about the studio component. */ studioComponent?: StudioComponent; } export interface DeleteStudioMemberRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The principal ID. */ principalId: __string; /** * The studio ID. */ studioId: __string; } export interface DeleteStudioMemberResponse { } export interface DeleteStudioRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The studio ID. */ studioId: __string; } export interface DeleteStudioResponse { /** * Information about a studio. */ studio?: Studio; } export type DirectoryId = string; export type EC2ImageId = string; export type EC2SubnetId = string; export type EC2SubnetIdList = EC2SubnetId[]; export interface Eula { /** * The EULA content. */ content?: __string; /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * The EULA ID. */ eulaId?: EulaId; /** * The name for the EULA. */ name?: EulaName; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; } export interface EulaAcceptance { /** * The Unix epoch timestamp in seconds for when the EULA was accepted. */ acceptedAt?: Timestamp; /** * The ID of the person who accepted the EULA. */ acceptedBy?: __string; /** * The ID of the acceptee. */ accepteeId?: __string; /** * The EULA acceptance ID. */ eulaAcceptanceId?: EulaAcceptanceId; /** * The EULA ID. */ eulaId?: EulaId; } export type EulaAcceptanceId = string; export type EulaAcceptanceList = EulaAcceptance[]; export type EulaId = string; export type EulaIdList = __string[]; export type EulaList = Eula[]; export type EulaName = string; export interface GetEulaRequest { /** * The EULA ID. */ eulaId: __string; } export interface GetEulaResponse { /** * The EULA. */ eula?: Eula; } export interface GetLaunchProfileDetailsRequest { /** * The launch profile ID. */ launchProfileId: __string; /** * The studio ID. */ studioId: __string; } export interface GetLaunchProfileDetailsResponse { /** * The launch profile. */ launchProfile?: LaunchProfile; /** * A collection of streaming images. */ streamingImages?: StreamingImageList; /** * A collection of studio component summaries. */ studioComponentSummaries?: StudioComponentSummaryList; } export interface GetLaunchProfileInitializationRequest { /** * The launch profile ID. */ launchProfileId: __string; /** * A collection of launch profile protocol versions. */ launchProfileProtocolVersions: multiValueQueryStringList; /** * The launch purpose. */ launchPurpose: __string; /** * The platform. */ platform: __string; /** * The studio ID. */ studioId: __string; } export interface GetLaunchProfileInitializationResponse { /** * The launch profile initialization. */ launchProfileInitialization?: LaunchProfileInitialization; } export interface GetLaunchProfileMemberRequest { /** * The launch profile ID. */ launchProfileId: __string; /** * The principal ID. */ principalId: __string; /** * The studio ID. */ studioId: __string; } export interface GetLaunchProfileMemberResponse { /** * The member. */ member?: LaunchProfileMembership; } export interface GetLaunchProfileRequest { /** * The launch profile ID. */ launchProfileId: __string; /** * The studio ID. */ studioId: __string; } export interface GetLaunchProfileResponse { /** * The launch profile. */ launchProfile?: LaunchProfile; } export interface GetStreamingImageRequest { /** * The streaming image ID. */ streamingImageId: __string; /** * The studio ID. */ studioId: __string; } export interface GetStreamingImageResponse { /** * The streaming image. */ streamingImage?: StreamingImage; } export interface GetStreamingSessionRequest { /** * The session ID. */ sessionId: __string; /** * The studio ID. */ studioId: __string; } export interface GetStreamingSessionResponse { /** * The session. */ session?: StreamingSession; } export interface GetStreamingSessionStreamRequest { /** * The session ID. */ sessionId: __string; /** * The stream ID. */ streamId: __string; /** * The studio ID. */ studioId: __string; } export interface GetStreamingSessionStreamResponse { /** * The stream. */ stream?: StreamingSessionStream; } export interface GetStudioComponentRequest { /** * The studio component ID. */ studioComponentId: __string; /** * The studio ID. */ studioId: __string; } export interface GetStudioComponentResponse { /** * Information about the studio component. */ studioComponent?: StudioComponent; } export interface GetStudioMemberRequest { /** * The principal ID. */ principalId: __string; /** * The studio ID. */ studioId: __string; } export interface GetStudioMemberResponse { /** * The member. */ member?: StudioMembership; } export interface GetStudioRequest { /** * The studio ID. */ studioId: __string; } export interface GetStudioResponse { /** * Information about a studio. */ studio?: Studio; } export interface LaunchProfile { /** * The ARN of the resource. */ arn?: __string; /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * The user ID of the user that created the launch profile. */ createdBy?: __string; /** * A human-readable description of the launch profile. */ description?: LaunchProfileDescription; /** * Unique identifiers for a collection of EC2 subnets. */ ec2SubnetIds?: EC2SubnetIdList; /** * The launch profile ID. */ launchProfileId?: LaunchProfileId; /** * The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31". */ launchProfileProtocolVersions?: LaunchProfileProtocolVersionList; /** * A friendly name for the launch profile. */ name?: LaunchProfileName; /** * 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?: LaunchProfileStudioComponentIdList; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; /** * The user ID of the user that most recently updated the resource. */ updatedBy?: __string; } export type LaunchProfileDescription = string; export type LaunchProfileId = string; export interface LaunchProfileInitialization { /** * A LaunchProfileInitializationActiveDirectory resource. */ activeDirectory?: LaunchProfileInitializationActiveDirectory; /** * The EC2 security groups that control access to the studio component. */ ec2SecurityGroupIds?: LaunchProfileSecurityGroupIdList; /** * The launch profile ID. */ launchProfileId?: LaunchProfileId; /** * The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31". */ launchProfileProtocolVersion?: LaunchProfileProtocolVersion; /** * The launch purpose. */ launchPurpose?: LaunchPurpose; /** * The name for the launch profile. */ name?: LaunchProfileName; /** * The platform of the launch platform, either WINDOWS or LINUX. */ platform?: LaunchProfilePlatform; /** * The system initializtion scripts. */ systemInitializationScripts?: LaunchProfileInitializationScriptList; /** * The user initializtion scripts. */ userInitializationScripts?: LaunchProfileInitializationScriptList; } export interface LaunchProfileInitializationActiveDirectory { /** * A collection of custom attributes for an Active Directory computer. */ computerAttributes?: ActiveDirectoryComputerAttributeList; /** * The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile. */ directoryId?: DirectoryId; /** * The directory name. */ directoryName?: __string; /** * The DNS IP address. */ dnsIpAddresses?: ActiveDirectoryDnsIpAddressList; /** * The name for the organizational unit distinguished name. */ organizationalUnitDistinguishedName?: ActiveDirectoryOrganizationalUnitDistinguishedName; /** * The unique identifier for a studio component resource. */ studioComponentId?: StudioComponentId; /** * The name for the studio component. */ studioComponentName?: StudioComponentName; } export interface LaunchProfileInitializationScript { /** * The initialization script. */ script?: StudioComponentInitializationScriptContent; /** * The unique identifier for a studio component resource. */ studioComponentId?: StudioComponentId; /** * The name for the studio component. */ studioComponentName?: StudioComponentName; } export type LaunchProfileInitializationScriptList = LaunchProfileInitializationScript[]; export type LaunchProfileList = LaunchProfile[]; export interface LaunchProfileMembership { /** * The ID of the identity store. */ identityStoreId?: __string; /** * The persona. */ persona?: LaunchProfilePersona; /** * The principal ID. */ principalId?: __string; } export type LaunchProfileMembershipList = LaunchProfileMembership[]; export type LaunchProfileName = string; export type LaunchProfilePersona = "USER"|string; export type LaunchProfilePlatform = "LINUX"|"WINDOWS"|string; export type LaunchProfileProtocolVersion = string; export type LaunchProfileProtocolVersionList = LaunchProfileProtocolVersion[]; export type LaunchProfileSecurityGroupIdList = SecurityGroupId[]; export type LaunchProfileState = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED"|string; export type LaunchProfileStatusCode = "LAUNCH_PROFILE_CREATED"|"LAUNCH_PROFILE_UPDATED"|"LAUNCH_PROFILE_DELETED"|"LAUNCH_PROFILE_CREATE_IN_PROGRESS"|"LAUNCH_PROFILE_UPDATE_IN_PROGRESS"|"LAUNCH_PROFILE_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"STREAMING_IMAGE_NOT_FOUND"|"STREAMING_IMAGE_NOT_READY"|"LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"|"ENCRYPTION_KEY_ACCESS_DENIED"|"ENCRYPTION_KEY_NOT_FOUND"|"INVALID_SUBNETS_PROVIDED"|string; export type LaunchProfileStudioComponentIdList = __string[]; export type LaunchPurpose = string; export interface LicenseServiceConfiguration { /** * The endpoint of the license service that is accessed by the studio component resource. */ endpoint?: __string; } export type LinuxMountPoint = string; export interface ListEulaAcceptancesRequest { /** * A collection of EULA IDs. */ eulaIds?: multiValueQueryStringList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The studio ID. */ studioId: __string; } export interface ListEulaAcceptancesResponse { /** * A collection of EULA acceptances. */ eulaAcceptances?: EulaAcceptanceList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListEulasRequest { /** * A collection of EULA IDs. */ eulaIds?: multiValueQueryStringList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListEulasResponse { /** * A collection of EULA resources. */ eulas?: EulaList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListLaunchProfileMembersRequest { /** * The launch profile ID. */ launchProfileId: __string; /** * The maximum number of results to be returned per request. */ maxResults?: MaxResults; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The studio ID. */ studioId: __string; } export interface ListLaunchProfileMembersResponse { /** * A list of members. */ members?: LaunchProfileMembershipList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListLaunchProfilesRequest { /** * The maximum number of results to be returned per request. */ maxResults?: MaxResults; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The principal ID. */ principalId?: __string; /** * A list of states. */ states?: multiValueQueryStringList; /** * The studio ID. */ studioId: __string; } export interface ListLaunchProfilesResponse { /** * A collection of launch profiles. */ launchProfiles?: LaunchProfileList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListStreamingImagesRequest { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The owner. */ owner?: __string; /** * The studio ID. */ studioId: __string; } export interface ListStreamingImagesResponse { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * A collection of streaming images. */ streamingImages?: StreamingImageList; } export interface ListStreamingSessionsRequest { /** * The user ID of the user that created the streaming session. */ createdBy?: __string; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The user ID of the user that owns the streaming session. */ ownedBy?: __string; /** * A collection of session IDs. */ sessionIds?: __string; /** * The studio ID. */ studioId: __string; } export interface ListStreamingSessionsResponse { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * A collection of streaming sessions. */ sessions?: StreamingSessionList; } export interface ListStudioComponentsRequest { /** * The maximum number of results to be returned per request. */ maxResults?: MaxResults; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * A list of states. */ states?: multiValueQueryStringList; /** * The studio ID. */ studioId: __string; /** * The types. */ types?: multiValueQueryStringList; } export interface ListStudioComponentsResponse { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * A collection of studio components. */ studioComponents?: StudioComponentList; } export interface ListStudioMembersRequest { /** * The maximum number of results to be returned per request. */ maxResults?: MaxResults; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * The studio ID. */ studioId: __string; } export interface ListStudioMembersResponse { /** * A list of members. */ members?: StudioMembershipList; /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListStudiosRequest { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; } export interface ListStudiosResponse { /** * The token for the next set of results, or null if there are no more results. */ nextToken?: __string; /** * A collection of studios. */ studios?: StudioList; } export interface ListTagsForResourceRequest { /** * The ARN of the target resource for tagging operations. */ resourceArn: __string; } export interface ListTagsForResourceResponse { /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export type MaxResults = number; export interface NewLaunchProfileMember { /** * The persona. */ persona: LaunchProfilePersona; /** * The principal ID. */ principalId: __string; } export type NewLaunchProfileMemberList = NewLaunchProfileMember[]; export interface NewStudioMember { /** * The persona. */ persona: StudioPersona; /** * The principal ID. */ principalId: __string; } export type NewStudioMemberList = NewStudioMember[]; export interface PutLaunchProfileMembersRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The ID of the identity store. */ identityStoreId: __string; /** * The launch profile ID. */ launchProfileId: __string; /** * A list of members. */ members: NewLaunchProfileMemberList; /** * The studio ID. */ studioId: __string; } export interface PutLaunchProfileMembersResponse { } export interface PutStudioMembersRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The ID of the identity store. */ identityStoreId: __string; /** * A list of members. */ members: NewStudioMemberList; /** * The studio ID. */ studioId: __string; } export interface PutStudioMembersResponse { } export type Region = string; export type ScriptParameterKey = string; export interface ScriptParameterKeyValue { /** * A script parameter key. */ key?: ScriptParameterKey; /** * A script parameter value. */ value?: ScriptParameterValue; } export type ScriptParameterValue = string; export type SecurityGroupId = string; export interface SharedFileSystemConfiguration { /** * 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?: LinuxMountPoint; /** * The name of the file share. */ shareName?: __string; /** * The mount location for a shared file system on a Windows virtual workstation. */ windowsMountDrive?: WindowsMountDrive; } export interface StartStudioSSOConfigurationRepairRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The studio ID. */ studioId: __string; } export interface StartStudioSSOConfigurationRepairResponse { /** * Information about a studio. */ studio?: Studio; } export interface StreamConfiguration { /** * Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client. */ clipboardMode?: StreamingClipboardMode; /** * The EC2 instance types that users can select from when launching a streaming session with this launch profile. */ ec2InstanceTypes?: StreamingInstanceTypeList; /** * The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session. */ maxSessionLengthInMinutes?: StreamConfigurationMaxSessionLengthInMinutes; /** * The streaming images that users can select from when launching a streaming session with this launch profile. */ streamingImageIds?: StreamingImageIdList; } export interface StreamConfigurationCreate { /** * Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client. */ clipboardMode: StreamingClipboardMode; /** * The EC2 instance types that users can select from when launching a streaming session with this launch profile. */ ec2InstanceTypes: StreamingInstanceTypeList; /** * The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session. */ maxSessionLengthInMinutes?: StreamConfigurationMaxSessionLengthInMinutes; /** * The streaming images that users can select from when launching a streaming session with this launch profile. */ streamingImageIds: StreamingImageIdList; } export type StreamConfigurationMaxSessionLengthInMinutes = number; export type StreamingClipboardMode = "ENABLED"|"DISABLED"|string; export interface StreamingImage { /** * The ARN of the resource. */ arn?: __string; /** * A human-readable description of the streaming image. */ description?: StreamingImageDescription; /** * The ID of an EC2 machine image with which to create the streaming image. */ ec2ImageId?: EC2ImageId; /** * 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?: EulaIdList; /** * A friendly name for a streaming image resource. */ name?: StreamingImageName; /** * 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?: StreamingImageOwner; /** * The platform of the streaming image, either WINDOWS or LINUX. */ platform?: StreamingImagePlatform; /** * 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?: StreamingImageId; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export type StreamingImageDescription = string; export interface StreamingImageEncryptionConfiguration { /** * The ARN for a KMS key that is used to encrypt studio data. */ keyArn?: StreamingImageEncryptionConfigurationKeyArn; /** * The type of KMS key that is used to encrypt studio data. */ keyType: StreamingImageEncryptionConfigurationKeyType; } export type StreamingImageEncryptionConfigurationKeyArn = string; export type StreamingImageEncryptionConfigurationKeyType = "CUSTOMER_MANAGED_KEY"|string; export type StreamingImageId = string; export type StreamingImageIdList = StreamingImageId[]; export type StreamingImageList = StreamingImage[]; export type StreamingImageName = string; export type StreamingImageOwner = string; export type StreamingImagePlatform = string; export type StreamingImageState = "CREATE_IN_PROGRESS"|"READY"|"DELETE_IN_PROGRESS"|"DELETED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"CREATE_FAILED"|"DELETE_FAILED"|string; export type StreamingImageStatusCode = "STREAMING_IMAGE_CREATE_IN_PROGRESS"|"STREAMING_IMAGE_READY"|"STREAMING_IMAGE_DELETE_IN_PROGRESS"|"STREAMING_IMAGE_DELETED"|"STREAMING_IMAGE_UPDATE_IN_PROGRESS"|"INTERNAL_ERROR"|string; export type StreamingInstanceType = "g4dn.xlarge"|"g4dn.2xlarge"|"g4dn.4xlarge"|"g4dn.8xlarge"|"g4dn.12xlarge"|"g4dn.16xlarge"|string; export type StreamingInstanceTypeList = StreamingInstanceType[]; export interface StreamingSession { /** * The ARN of the resource. */ arn?: __string; /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * 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 user ID of the user that owns the streaming session. */ ownedBy?: __string; /** * The session ID. */ sessionId?: StreamingSessionId; /** * The current state. */ state?: StreamingSessionState; /** * The status code. */ statusCode?: StreamingSessionStatusCode; /** * The status message for the streaming session. */ statusMessage?: __string; /** * The ID of the streaming image. */ streamingImageId?: StreamingImageId; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; /** * The time the streaming session will automatically terminate if not terminated by the user. */ terminateAt?: Timestamp; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; /** * The user ID of the user that most recently updated the resource. */ updatedBy?: __string; } export type StreamingSessionId = string; export type StreamingSessionList = StreamingSession[]; export type StreamingSessionState = "CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"READY"|"DELETED"|"CREATE_FAILED"|"DELETE_FAILED"|string; export type StreamingSessionStatusCode = "STREAMING_SESSION_READY"|"STREAMING_SESSION_DELETED"|"STREAMING_SESSION_CREATE_IN_PROGRESS"|"STREAMING_SESSION_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"INSUFFICIENT_CAPACITY"|"ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"|"NETWORK_CONNECTION_ERROR"|"INITIALIZATION_SCRIPT_ERROR"|"DECRYPT_STREAMING_IMAGE_ERROR"|"NETWORK_INTERFACE_ERROR"|string; export interface StreamingSessionStream { /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * The user ID of the user that created the streaming session stream. */ createdBy?: __string; /** * The Unix epoch timestamp in seconds for when the resource expires. */ expiresAt?: Timestamp; /** * The user ID of the user that owns the streaming session. */ 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; } export type StreamingSessionStreamExpirationInSeconds = number; export type StreamingSessionStreamState = "READY"|"CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"CREATE_FAILED"|"DELETE_FAILED"|string; export type StreamingSessionStreamStatusCode = "STREAM_CREATE_IN_PROGRESS"|"STREAM_READY"|"STREAM_DELETE_IN_PROGRESS"|"STREAM_DELETED"|"INTERNAL_ERROR"|"NETWORK_CONNECTION_ERROR"|string; export interface Studio { /** * 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 Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * A friendly name for the studio. */ displayName?: StudioDisplayName; /** * The Amazon Web Services Region where the studio resource is located. */ homeRegion?: Region; /** * The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble 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?: StudioName; /** * 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?: Tags; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; /** * The IAM role that studio users assume when logging in to the Nimble Studio portal. */ userRoleArn?: __string; } export interface StudioComponent { /** * The ARN of the resource. */ arn?: __string; /** * The configuration of the studio component, based on component type. */ configuration?: StudioComponentConfiguration; /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * The user ID of the user that created the studio component. */ createdBy?: __string; /** * A human-readable description for the studio component resource. */ description?: StudioComponentDescription; /** * The EC2 security groups that control access to the studio component. */ ec2SecurityGroupIds?: StudioComponentSecurityGroupIdList; /** * Initialization scripts for studio components. */ initializationScripts?: StudioComponentInitializationScriptList; /** * A friendly name for the studio component resource. */ name?: StudioComponentName; /** * Parameters for the studio component scripts. */ scriptParameters?: StudioComponentScriptParameterKeyValueList; /** * 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?: StudioComponentId; /** * 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?: Tags; /** * The type of the studio component. */ type?: StudioComponentType; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; /** * The user ID of the user that most recently updated the resource. */ updatedBy?: __string; } export interface StudioComponentConfiguration { /** * The configuration for a Microsoft Active Directory (Microsoft AD) 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; } export type StudioComponentDescription = string; export type StudioComponentId = string; export interface StudioComponentInitializationScript { /** * The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31". */ launchProfileProtocolVersion?: LaunchProfileProtocolVersion; /** * 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?: StudioComponentInitializationScriptContent; } export type StudioComponentInitializationScriptContent = string; export type StudioComponentInitializationScriptList = StudioComponentInitializationScript[]; export type StudioComponentInitializationScriptRunContext = "SYSTEM_INITIALIZATION"|"USER_INITIALIZATION"|string; export type StudioComponentList = StudioComponent[]; export type StudioComponentName = string; export type StudioComponentScriptParameterKeyValueList = ScriptParameterKeyValue[]; export type StudioComponentSecurityGroupIdList = SecurityGroupId[]; export type StudioComponentState = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED"|string; export type StudioComponentStatusCode = "ACTIVE_DIRECTORY_ALREADY_EXISTS"|"STUDIO_COMPONENT_CREATED"|"STUDIO_COMPONENT_UPDATED"|"STUDIO_COMPONENT_DELETED"|"ENCRYPTION_KEY_ACCESS_DENIED"|"ENCRYPTION_KEY_NOT_FOUND"|"STUDIO_COMPONENT_CREATE_IN_PROGRESS"|"STUDIO_COMPONENT_UPDATE_IN_PROGRESS"|"STUDIO_COMPONENT_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|string; export type StudioComponentSubtype = "AWS_MANAGED_MICROSOFT_AD"|"AMAZON_FSX_FOR_WINDOWS"|"AMAZON_FSX_FOR_LUSTRE"|"CUSTOM"|string; export interface StudioComponentSummary { /** * The Unix epoch timestamp in seconds for when the resource was created. */ createdAt?: Timestamp; /** * The user ID of the user that created the studio component. */ createdBy?: __string; /** * The description. */ description?: StudioComponentDescription; /** * The name for the studio component. */ name?: StudioComponentName; /** * The unique identifier for a studio component resource. */ studioComponentId?: StudioComponentId; /** * The specific subtype of a studio component. */ subtype?: StudioComponentSubtype; /** * The type of the studio component. */ type?: StudioComponentType; /** * The Unix epoch timestamp in seconds for when the resource was updated. */ updatedAt?: Timestamp; /** * The user ID of the user that most recently updated the resource. */ updatedBy?: __string; } export type StudioComponentSummaryList = StudioComponentSummary[]; export type StudioComponentType = "ACTIVE_DIRECTORY"|"SHARED_FILE_SYSTEM"|"COMPUTE_FARM"|"LICENSE_SERVICE"|"CUSTOM"|string; export type StudioDisplayName = string; export interface StudioEncryptionConfiguration { /** * The ARN for a KMS key that is used to encrypt studio data. */ keyArn?: StudioEncryptionConfigurationKeyArn; /** * The type of KMS key that is used to encrypt studio data. */ keyType: StudioEncryptionConfigurationKeyType; } export type StudioEncryptionConfigurationKeyArn = string; export type StudioEncryptionConfigurationKeyType = "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KEY"|string; export type StudioList = Studio[]; export interface StudioMembership { /** * The ID of the identity store. */ identityStoreId?: __string; /** * The persona. */ persona?: StudioPersona; /** * The principal ID. */ principalId?: __string; } export type StudioMembershipList = StudioMembership[]; export type StudioName = string; export type StudioPersona = "ADMINISTRATOR"|string; export type StudioState = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED"|string; export type StudioStatusCode = "STUDIO_CREATED"|"STUDIO_DELETED"|"STUDIO_UPDATED"|"STUDIO_CREATE_IN_PROGRESS"|"STUDIO_UPDATE_IN_PROGRESS"|"STUDIO_DELETE_IN_PROGRESS"|"STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"|"STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"|"STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"|"AWS_SSO_NOT_ENABLED"|"AWS_SSO_ACCESS_DENIED"|"ROLE_NOT_OWNED_BY_STUDIO_OWNER"|"ROLE_COULD_NOT_BE_ASSUMED"|"INTERNAL_ERROR"|"ENCRYPTION_KEY_NOT_FOUND"|"ENCRYPTION_KEY_ACCESS_DENIED"|"AWS_SSO_CONFIGURATION_REPAIRED"|"AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"|string; export interface TagResourceRequest { /** * The ARN of the target resource for tagging operations. */ resourceArn: __string; /** * A collection of labels, in the form of key:value pairs, that apply to this resource. */ tags?: Tags; } export interface TagResourceResponse { } export type Tags = {[key: string]: __string}; export type Timestamp = Date; export interface UntagResourceRequest { /** * The ARN of the target resource for tagging operations. */ resourceArn: __string; /** * An array of tag keys to delete. */ tagKeys: multiValueQueryStringList; } export interface UntagResourceResponse { } export interface UpdateLaunchProfileMemberRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The launch profile ID. */ launchProfileId: __string; /** * The persona. */ persona: LaunchProfilePersona; /** * The principal ID. */ principalId: __string; /** * The studio ID. */ studioId: __string; } export interface UpdateLaunchProfileMemberResponse { /** * The member. */ member?: LaunchProfileMembership; } export interface UpdateLaunchProfileRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The description. */ description?: LaunchProfileDescription; /** * The launch profile ID. */ launchProfileId: __string; /** * The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31". */ launchProfileProtocolVersions?: LaunchProfileProtocolVersionList; /** * The name for the launch profile. */ name?: LaunchProfileName; /** * A configuration for a streaming session. */ streamConfiguration?: StreamConfigurationCreate; /** * Unique identifiers for a collection of studio components that can be used with this launch profile. */ studioComponentIds?: LaunchProfileStudioComponentIdList; /** * The studio ID. */ studioId: __string; } export interface UpdateLaunchProfileResponse { /** * The launch profile. */ launchProfile?: LaunchProfile; } export interface UpdateStreamingImageRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The description. */ description?: StreamingImageDescription; /** * The name for the streaming image. */ name?: StreamingImageName; /** * The streaming image ID. */ streamingImageId: __string; /** * The studio ID. */ studioId: __string; } export interface UpdateStreamingImageResponse { /** * */ streamingImage?: StreamingImage; } export interface UpdateStudioComponentRequest { /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * The configuration of the studio component, based on component type. */ configuration?: StudioComponentConfiguration; /** * The description. */ description?: StudioComponentDescription; /** * The EC2 security groups that control access to the studio component. */ ec2SecurityGroupIds?: StudioComponentSecurityGroupIdList; /** * Initialization scripts for studio components. */ initializationScripts?: StudioComponentInitializationScriptList; /** * The name for the studio component. */ name?: StudioComponentName; /** * Parameters for the studio component scripts. */ scriptParameters?: StudioComponentScriptParameterKeyValueList; /** * The studio component ID. */ studioComponentId: __string; /** * The studio ID. */ studioId: __string; /** * The specific subtype of a studio component. */ subtype?: StudioComponentSubtype; /** * The type of the studio component. */ type?: StudioComponentType; } export interface UpdateStudioComponentResponse { /** * Information about the studio component. */ studioComponent?: StudioComponent; } export interface UpdateStudioRequest { /** * The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal. */ adminRoleArn?: __string; /** * To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error. */ clientToken?: ClientToken; /** * A friendly name for the studio. */ displayName?: StudioDisplayName; /** * The studio ID. */ studioId: __string; /** * The IAM role that Studio Users will assume when logging in to the Nimble Studio portal. */ userRoleArn?: __string; } export interface UpdateStudioResponse { /** * Information about a studio. */ studio?: Studio; } export type WindowsMountDrive = string; export type __string = string; export type ClientToken = string; export type multiValueQueryStringList = __string[]; /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2020-08-01"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the Nimble client. */ export import Types = Nimble; } export = Nimble;