aws-sdk
Version:
AWS SDK for JavaScript
673 lines • 124 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} 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<Nimble.Types.AcceptEulasResponse, AWSError>;
/**
* Accept EULAs.
*/
acceptEulas(callback?: (err: AWSError, data: Nimble.Types.AcceptEulasResponse) => void): Request<Nimble.Types.AcceptEulasResponse, AWSError>;
/**
* Create a launch profile.
*/
createLaunchProfile(params: Nimble.Types.CreateLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.CreateLaunchProfileResponse) => void): Request<Nimble.Types.CreateLaunchProfileResponse, AWSError>;
/**
* Create a launch profile.
*/
createLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.CreateLaunchProfileResponse) => void): Request<Nimble.Types.CreateLaunchProfileResponse, AWSError>;
/**
* Creates a streaming image resource in a studio.
*/
createStreamingImage(params: Nimble.Types.CreateStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingImageResponse) => void): Request<Nimble.Types.CreateStreamingImageResponse, AWSError>;
/**
* Creates a streaming image resource in a studio.
*/
createStreamingImage(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingImageResponse) => void): Request<Nimble.Types.CreateStreamingImageResponse, AWSError>;
/**
* Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.
*/
createStreamingSession(params: Nimble.Types.CreateStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionResponse) => void): Request<Nimble.Types.CreateStreamingSessionResponse, AWSError>;
/**
* Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.
*/
createStreamingSession(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionResponse) => void): Request<Nimble.Types.CreateStreamingSessionResponse, AWSError>;
/**
* 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 the READY state.
*/
createStreamingSessionStream(params: Nimble.Types.CreateStreamingSessionStreamRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionStreamResponse) => void): Request<Nimble.Types.CreateStreamingSessionStreamResponse, AWSError>;
/**
* 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 the READY state.
*/
createStreamingSessionStream(callback?: (err: AWSError, data: Nimble.Types.CreateStreamingSessionStreamResponse) => void): Request<Nimble.Types.CreateStreamingSessionStreamResponse, AWSError>;
/**
* 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<Nimble.Types.CreateStudioResponse, AWSError>;
/**
* 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<Nimble.Types.CreateStudioResponse, AWSError>;
/**
* Creates a studio component resource.
*/
createStudioComponent(params: Nimble.Types.CreateStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.CreateStudioComponentResponse) => void): Request<Nimble.Types.CreateStudioComponentResponse, AWSError>;
/**
* Creates a studio component resource.
*/
createStudioComponent(callback?: (err: AWSError, data: Nimble.Types.CreateStudioComponentResponse) => void): Request<Nimble.Types.CreateStudioComponentResponse, AWSError>;
/**
* Permanently delete a launch profile.
*/
deleteLaunchProfile(params: Nimble.Types.DeleteLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileResponse) => void): Request<Nimble.Types.DeleteLaunchProfileResponse, AWSError>;
/**
* Permanently delete a launch profile.
*/
deleteLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileResponse) => void): Request<Nimble.Types.DeleteLaunchProfileResponse, AWSError>;
/**
* Delete a user from launch profile membership.
*/
deleteLaunchProfileMember(params: Nimble.Types.DeleteLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileMemberResponse) => void): Request<Nimble.Types.DeleteLaunchProfileMemberResponse, AWSError>;
/**
* Delete a user from launch profile membership.
*/
deleteLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.DeleteLaunchProfileMemberResponse) => void): Request<Nimble.Types.DeleteLaunchProfileMemberResponse, AWSError>;
/**
* Delete streaming image.
*/
deleteStreamingImage(params: Nimble.Types.DeleteStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingImageResponse) => void): Request<Nimble.Types.DeleteStreamingImageResponse, AWSError>;
/**
* Delete streaming image.
*/
deleteStreamingImage(callback?: (err: AWSError, data: Nimble.Types.DeleteStreamingImageResponse) => void): Request<Nimble.Types.DeleteStreamingImageResponse, AWSError>;
/**
* 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<Nimble.Types.DeleteStreamingSessionResponse, AWSError>;
/**
* 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<Nimble.Types.DeleteStreamingSessionResponse, AWSError>;
/**
* Delete a studio resource.
*/
deleteStudio(params: Nimble.Types.DeleteStudioRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioResponse) => void): Request<Nimble.Types.DeleteStudioResponse, AWSError>;
/**
* Delete a studio resource.
*/
deleteStudio(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioResponse) => void): Request<Nimble.Types.DeleteStudioResponse, AWSError>;
/**
* Deletes a studio component resource.
*/
deleteStudioComponent(params: Nimble.Types.DeleteStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioComponentResponse) => void): Request<Nimble.Types.DeleteStudioComponentResponse, AWSError>;
/**
* Deletes a studio component resource.
*/
deleteStudioComponent(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioComponentResponse) => void): Request<Nimble.Types.DeleteStudioComponentResponse, AWSError>;
/**
* Delete a user from studio membership.
*/
deleteStudioMember(params: Nimble.Types.DeleteStudioMemberRequest, callback?: (err: AWSError, data: Nimble.Types.DeleteStudioMemberResponse) => void): Request<Nimble.Types.DeleteStudioMemberResponse, AWSError>;
/**
* Delete a user from studio membership.
*/
deleteStudioMember(callback?: (err: AWSError, data: Nimble.Types.DeleteStudioMemberResponse) => void): Request<Nimble.Types.DeleteStudioMemberResponse, AWSError>;
/**
* Get EULA.
*/
getEula(params: Nimble.Types.GetEulaRequest, callback?: (err: AWSError, data: Nimble.Types.GetEulaResponse) => void): Request<Nimble.Types.GetEulaResponse, AWSError>;
/**
* Get EULA.
*/
getEula(callback?: (err: AWSError, data: Nimble.Types.GetEulaResponse) => void): Request<Nimble.Types.GetEulaResponse, AWSError>;
/**
* Get a launch profile.
*/
getLaunchProfile(params: Nimble.Types.GetLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* Get a launch profile.
*/
getLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* 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<Nimble.Types.GetLaunchProfileDetailsResponse, AWSError>;
/**
* 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<Nimble.Types.GetLaunchProfileDetailsResponse, AWSError>;
/**
* Get a launch profile initialization.
*/
getLaunchProfileInitialization(params: Nimble.Types.GetLaunchProfileInitializationRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileInitializationResponse) => void): Request<Nimble.Types.GetLaunchProfileInitializationResponse, AWSError>;
/**
* Get a launch profile initialization.
*/
getLaunchProfileInitialization(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileInitializationResponse) => void): Request<Nimble.Types.GetLaunchProfileInitializationResponse, AWSError>;
/**
* Get a user persona in launch profile membership.
*/
getLaunchProfileMember(params: Nimble.Types.GetLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileMemberResponse) => void): Request<Nimble.Types.GetLaunchProfileMemberResponse, AWSError>;
/**
* Get a user persona in launch profile membership.
*/
getLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileMemberResponse) => void): Request<Nimble.Types.GetLaunchProfileMemberResponse, AWSError>;
/**
* Get streaming image.
*/
getStreamingImage(params: Nimble.Types.GetStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* Get streaming image.
*/
getStreamingImage(callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* 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<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* 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<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Gets StreamingSessionBackup resource. Invoke this operation to poll for a streaming session backup while stopping a streaming session.
*/
getStreamingSessionBackup(params: Nimble.Types.GetStreamingSessionBackupRequest, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionBackupResponse) => void): Request<Nimble.Types.GetStreamingSessionBackupResponse, AWSError>;
/**
* Gets StreamingSessionBackup resource. Invoke this operation to poll for a streaming session backup while stopping a streaming session.
*/
getStreamingSessionBackup(callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionBackupResponse) => void): Request<Nimble.Types.GetStreamingSessionBackupResponse, AWSError>;
/**
* Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream changes to the READY state, 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<Nimble.Types.GetStreamingSessionStreamResponse, AWSError>;
/**
* Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream changes to the READY state, 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<Nimble.Types.GetStreamingSessionStreamResponse, AWSError>;
/**
* Get a studio resource.
*/
getStudio(params: Nimble.Types.GetStudioRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
/**
* Get a studio resource.
*/
getStudio(callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
/**
* Gets a studio component resource.
*/
getStudioComponent(params: Nimble.Types.GetStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Gets a studio component resource.
*/
getStudioComponent(callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Get a user's membership in a studio.
*/
getStudioMember(params: Nimble.Types.GetStudioMemberRequest, callback?: (err: AWSError, data: Nimble.Types.GetStudioMemberResponse) => void): Request<Nimble.Types.GetStudioMemberResponse, AWSError>;
/**
* Get a user's membership in a studio.
*/
getStudioMember(callback?: (err: AWSError, data: Nimble.Types.GetStudioMemberResponse) => void): Request<Nimble.Types.GetStudioMemberResponse, AWSError>;
/**
* List EULA acceptances.
*/
listEulaAcceptances(params: Nimble.Types.ListEulaAcceptancesRequest, callback?: (err: AWSError, data: Nimble.Types.ListEulaAcceptancesResponse) => void): Request<Nimble.Types.ListEulaAcceptancesResponse, AWSError>;
/**
* List EULA acceptances.
*/
listEulaAcceptances(callback?: (err: AWSError, data: Nimble.Types.ListEulaAcceptancesResponse) => void): Request<Nimble.Types.ListEulaAcceptancesResponse, AWSError>;
/**
* List EULAs.
*/
listEulas(params: Nimble.Types.ListEulasRequest, callback?: (err: AWSError, data: Nimble.Types.ListEulasResponse) => void): Request<Nimble.Types.ListEulasResponse, AWSError>;
/**
* List EULAs.
*/
listEulas(callback?: (err: AWSError, data: Nimble.Types.ListEulasResponse) => void): Request<Nimble.Types.ListEulasResponse, AWSError>;
/**
* Get all users in a given launch profile membership.
*/
listLaunchProfileMembers(params: Nimble.Types.ListLaunchProfileMembersRequest, callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfileMembersResponse) => void): Request<Nimble.Types.ListLaunchProfileMembersResponse, AWSError>;
/**
* Get all users in a given launch profile membership.
*/
listLaunchProfileMembers(callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfileMembersResponse) => void): Request<Nimble.Types.ListLaunchProfileMembersResponse, AWSError>;
/**
* List all the launch profiles a studio.
*/
listLaunchProfiles(params: Nimble.Types.ListLaunchProfilesRequest, callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfilesResponse) => void): Request<Nimble.Types.ListLaunchProfilesResponse, AWSError>;
/**
* List all the launch profiles a studio.
*/
listLaunchProfiles(callback?: (err: AWSError, data: Nimble.Types.ListLaunchProfilesResponse) => void): Request<Nimble.Types.ListLaunchProfilesResponse, AWSError>;
/**
* 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<Nimble.Types.ListStreamingImagesResponse, AWSError>;
/**
* 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<Nimble.Types.ListStreamingImagesResponse, AWSError>;
/**
* Lists the backups of a streaming session in a studio.
*/
listStreamingSessionBackups(params: Nimble.Types.ListStreamingSessionBackupsRequest, callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionBackupsResponse) => void): Request<Nimble.Types.ListStreamingSessionBackupsResponse, AWSError>;
/**
* Lists the backups of a streaming session in a studio.
*/
listStreamingSessionBackups(callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionBackupsResponse) => void): Request<Nimble.Types.ListStreamingSessionBackupsResponse, AWSError>;
/**
* Lists the streaming sessions in a studio.
*/
listStreamingSessions(params: Nimble.Types.ListStreamingSessionsRequest, callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionsResponse) => void): Request<Nimble.Types.ListStreamingSessionsResponse, AWSError>;
/**
* Lists the streaming sessions in a studio.
*/
listStreamingSessions(callback?: (err: AWSError, data: Nimble.Types.ListStreamingSessionsResponse) => void): Request<Nimble.Types.ListStreamingSessionsResponse, AWSError>;
/**
* Lists the StudioComponents in a studio.
*/
listStudioComponents(params: Nimble.Types.ListStudioComponentsRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudioComponentsResponse) => void): Request<Nimble.Types.ListStudioComponentsResponse, AWSError>;
/**
* Lists the StudioComponents in a studio.
*/
listStudioComponents(callback?: (err: AWSError, data: Nimble.Types.ListStudioComponentsResponse) => void): Request<Nimble.Types.ListStudioComponentsResponse, AWSError>;
/**
* Get all users in a given studio membership. ListStudioMembers only returns admin members.
*/
listStudioMembers(params: Nimble.Types.ListStudioMembersRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudioMembersResponse) => void): Request<Nimble.Types.ListStudioMembersResponse, AWSError>;
/**
* Get all users in a given studio membership. ListStudioMembers only returns admin members.
*/
listStudioMembers(callback?: (err: AWSError, data: Nimble.Types.ListStudioMembersResponse) => void): Request<Nimble.Types.ListStudioMembersResponse, AWSError>;
/**
* List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
*/
listStudios(params: Nimble.Types.ListStudiosRequest, callback?: (err: AWSError, data: Nimble.Types.ListStudiosResponse) => void): Request<Nimble.Types.ListStudiosResponse, AWSError>;
/**
* List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
*/
listStudios(callback?: (err: AWSError, data: Nimble.Types.ListStudiosResponse) => void): Request<Nimble.Types.ListStudiosResponse, AWSError>;
/**
* 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<Nimble.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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<Nimble.Types.ListTagsForResourceResponse, AWSError>;
/**
* Add/update users with given persona to launch profile membership.
*/
putLaunchProfileMembers(params: Nimble.Types.PutLaunchProfileMembersRequest, callback?: (err: AWSError, data: Nimble.Types.PutLaunchProfileMembersResponse) => void): Request<Nimble.Types.PutLaunchProfileMembersResponse, AWSError>;
/**
* Add/update users with given persona to launch profile membership.
*/
putLaunchProfileMembers(callback?: (err: AWSError, data: Nimble.Types.PutLaunchProfileMembersResponse) => void): Request<Nimble.Types.PutLaunchProfileMembersResponse, AWSError>;
/**
* Add/update users with given persona to studio membership.
*/
putStudioMembers(params: Nimble.Types.PutStudioMembersRequest, callback?: (err: AWSError, data: Nimble.Types.PutStudioMembersResponse) => void): Request<Nimble.Types.PutStudioMembersResponse, AWSError>;
/**
* Add/update users with given persona to studio membership.
*/
putStudioMembers(callback?: (err: AWSError, data: Nimble.Types.PutStudioMembersResponse) => void): Request<Nimble.Types.PutStudioMembersResponse, AWSError>;
/**
* Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
*/
startStreamingSession(params: Nimble.Types.StartStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.StartStreamingSessionResponse) => void): Request<Nimble.Types.StartStreamingSessionResponse, AWSError>;
/**
* Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
*/
startStreamingSession(callback?: (err: AWSError, data: Nimble.Types.StartStreamingSessionResponse) => void): Request<Nimble.Types.StartStreamingSessionResponse, AWSError>;
/**
* Repairs the IAM Identity Center configuration for a given studio. If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state. After the IAM Identity Center 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<Nimble.Types.StartStudioSSOConfigurationRepairResponse, AWSError>;
/**
* Repairs the IAM Identity Center configuration for a given studio. If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state. After the IAM Identity Center 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<Nimble.Types.StartStudioSSOConfigurationRepairResponse, AWSError>;
/**
* Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.
*/
stopStreamingSession(params: Nimble.Types.StopStreamingSessionRequest, callback?: (err: AWSError, data: Nimble.Types.StopStreamingSessionResponse) => void): Request<Nimble.Types.StopStreamingSessionResponse, AWSError>;
/**
* Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.
*/
stopStreamingSession(callback?: (err: AWSError, data: Nimble.Types.StopStreamingSessionResponse) => void): Request<Nimble.Types.StopStreamingSessionResponse, AWSError>;
/**
* Creates tags for a resource, given its ARN.
*/
tagResource(params: Nimble.Types.TagResourceRequest, callback?: (err: AWSError, data: Nimble.Types.TagResourceResponse) => void): Request<Nimble.Types.TagResourceResponse, AWSError>;
/**
* Creates tags for a resource, given its ARN.
*/
tagResource(callback?: (err: AWSError, data: Nimble.Types.TagResourceResponse) => void): Request<Nimble.Types.TagResourceResponse, AWSError>;
/**
* Deletes the tags for a resource.
*/
untagResource(params: Nimble.Types.UntagResourceRequest, callback?: (err: AWSError, data: Nimble.Types.UntagResourceResponse) => void): Request<Nimble.Types.UntagResourceResponse, AWSError>;
/**
* Deletes the tags for a resource.
*/
untagResource(callback?: (err: AWSError, data: Nimble.Types.UntagResourceResponse) => void): Request<Nimble.Types.UntagResourceResponse, AWSError>;
/**
* Update a launch profile.
*/
updateLaunchProfile(params: Nimble.Types.UpdateLaunchProfileRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileResponse) => void): Request<Nimble.Types.UpdateLaunchProfileResponse, AWSError>;
/**
* Update a launch profile.
*/
updateLaunchProfile(callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileResponse) => void): Request<Nimble.Types.UpdateLaunchProfileResponse, AWSError>;
/**
* Update a user persona in launch profile membership.
*/
updateLaunchProfileMember(params: Nimble.Types.UpdateLaunchProfileMemberRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileMemberResponse) => void): Request<Nimble.Types.UpdateLaunchProfileMemberResponse, AWSError>;
/**
* Update a user persona in launch profile membership.
*/
updateLaunchProfileMember(callback?: (err: AWSError, data: Nimble.Types.UpdateLaunchProfileMemberResponse) => void): Request<Nimble.Types.UpdateLaunchProfileMemberResponse, AWSError>;
/**
* Update streaming image.
*/
updateStreamingImage(params: Nimble.Types.UpdateStreamingImageRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateStreamingImageResponse) => void): Request<Nimble.Types.UpdateStreamingImageResponse, AWSError>;
/**
* Update streaming image.
*/
updateStreamingImage(callback?: (err: AWSError, data: Nimble.Types.UpdateStreamingImageResponse) => void): Request<Nimble.Types.UpdateStreamingImageResponse, AWSError>;
/**
* 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<Nimble.Types.UpdateStudioResponse, AWSError>;
/**
* 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<Nimble.Types.UpdateStudioResponse, AWSError>;
/**
* Updates a studio component resource.
*/
updateStudioComponent(params: Nimble.Types.UpdateStudioComponentRequest, callback?: (err: AWSError, data: Nimble.Types.UpdateStudioComponentResponse) => void): Request<Nimble.Types.UpdateStudioComponentResponse, AWSError>;
/**
* Updates a studio component resource.
*/
updateStudioComponent(callback?: (err: AWSError, data: Nimble.Types.UpdateStudioComponentResponse) => void): Request<Nimble.Types.UpdateStudioComponentResponse, AWSError>;
/**
* Waits for the launchProfileDeleted state by periodically calling the underlying Nimble.getLaunchProfileoperation every 5 seconds (at most 150 times). Wait until a LaunchProfile is Deleted. Use this after invoking DeleteLaunchProfile
*/
waitFor(state: "launchProfileDeleted", params: Nimble.Types.GetLaunchProfileRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* Waits for the launchProfileDeleted state by periodically calling the underlying Nimble.getLaunchProfileoperation every 5 seconds (at most 150 times). Wait until a LaunchProfile is Deleted. Use this after invoking DeleteLaunchProfile
*/
waitFor(state: "launchProfileDeleted", callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* Waits for the launchProfileReady state by periodically calling the underlying Nimble.getLaunchProfileoperation every 5 seconds (at most 150 times). Wait until a LaunchProfile is Ready. Use this after invoking CreateLaunchProfile or UpdateLaunchProfile
*/
waitFor(state: "launchProfileReady", params: Nimble.Types.GetLaunchProfileRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* Waits for the launchProfileReady state by periodically calling the underlying Nimble.getLaunchProfileoperation every 5 seconds (at most 150 times). Wait until a LaunchProfile is Ready. Use this after invoking CreateLaunchProfile or UpdateLaunchProfile
*/
waitFor(state: "launchProfileReady", callback?: (err: AWSError, data: Nimble.Types.GetLaunchProfileResponse) => void): Request<Nimble.Types.GetLaunchProfileResponse, AWSError>;
/**
* Waits for the streamingImageDeleted state by periodically calling the underlying Nimble.getStreamingImageoperation every 2 seconds (at most 60 times). Wait until a StreamingImage Deleted. Use this after invoking DeleteStreamingImage
*/
waitFor(state: "streamingImageDeleted", params: Nimble.Types.GetStreamingImageRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* Waits for the streamingImageDeleted state by periodically calling the underlying Nimble.getStreamingImageoperation every 2 seconds (at most 60 times). Wait until a StreamingImage Deleted. Use this after invoking DeleteStreamingImage
*/
waitFor(state: "streamingImageDeleted", callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* Waits for the streamingImageReady state by periodically calling the underlying Nimble.getStreamingImageoperation every 2 seconds (at most 60 times). Wait until a StreamingImage is Ready. Use this after invoking CreateStreamingImage or UpdateStreamingImage
*/
waitFor(state: "streamingImageReady", params: Nimble.Types.GetStreamingImageRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* Waits for the streamingImageReady state by periodically calling the underlying Nimble.getStreamingImageoperation every 2 seconds (at most 60 times). Wait until a StreamingImage is Ready. Use this after invoking CreateStreamingImage or UpdateStreamingImage
*/
waitFor(state: "streamingImageReady", callback?: (err: AWSError, data: Nimble.Types.GetStreamingImageResponse) => void): Request<Nimble.Types.GetStreamingImageResponse, AWSError>;
/**
* Waits for the streamingSessionDeleted state by periodically calling the underlying Nimble.getStreamingSessionoperation every 5 seconds (at most 180 times). Wait until a StreamingSessionDeleted. Use this after invoking DeleteStreamingSession
*/
waitFor(state: "streamingSessionDeleted", params: Nimble.Types.GetStreamingSessionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionDeleted state by periodically calling the underlying Nimble.getStreamingSessionoperation every 5 seconds (at most 180 times). Wait until a StreamingSessionDeleted. Use this after invoking DeleteStreamingSession
*/
waitFor(state: "streamingSessionDeleted", callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionReady state by periodically calling the underlying Nimble.getStreamingSessionoperation every 10 seconds (at most 180 times). Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession
*/
waitFor(state: "streamingSessionReady", params: Nimble.Types.GetStreamingSessionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionReady state by periodically calling the underlying Nimble.getStreamingSessionoperation every 10 seconds (at most 180 times). Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession
*/
waitFor(state: "streamingSessionReady", callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionStopped state by periodically calling the underlying Nimble.getStreamingSessionoperation every 5 seconds (at most 180 times). Wait until a StreamingSessionStopped. Use this after invoking StopStreamingSession
*/
waitFor(state: "streamingSessionStopped", params: Nimble.Types.GetStreamingSessionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionStopped state by periodically calling the underlying Nimble.getStreamingSessionoperation every 5 seconds (at most 180 times). Wait until a StreamingSessionStopped. Use this after invoking StopStreamingSession
*/
waitFor(state: "streamingSessionStopped", callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionResponse) => void): Request<Nimble.Types.GetStreamingSessionResponse, AWSError>;
/**
* Waits for the streamingSessionStreamReady state by periodically calling the underlying Nimble.getStreamingSessionStreamoperation every 5 seconds (at most 30 times). Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream
*/
waitFor(state: "streamingSessionStreamReady", params: Nimble.Types.GetStreamingSessionStreamRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionStreamResponse) => void): Request<Nimble.Types.GetStreamingSessionStreamResponse, AWSError>;
/**
* Waits for the streamingSessionStreamReady state by periodically calling the underlying Nimble.getStreamingSessionStreamoperation every 5 seconds (at most 30 times). Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream
*/
waitFor(state: "streamingSessionStreamReady", callback?: (err: AWSError, data: Nimble.Types.GetStreamingSessionStreamResponse) => void): Request<Nimble.Types.GetStreamingSessionStreamResponse, AWSError>;
/**
* Waits for the studioComponentDeleted state by periodically calling the underlying Nimble.getStudioComponentoperation every 1 seconds (at most 120 times). Wait until a StudioComponent Deleted. Use this after invoking DeleteStudioComponent
*/
waitFor(state: "studioComponentDeleted", params: Nimble.Types.GetStudioComponentRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Waits for the studioComponentDeleted state by periodically calling the underlying Nimble.getStudioComponentoperation every 1 seconds (at most 120 times). Wait until a StudioComponent Deleted. Use this after invoking DeleteStudioComponent
*/
waitFor(state: "studioComponentDeleted", callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Waits for the studioComponentReady state by periodically calling the underlying Nimble.getStudioComponentoperation every 2 seconds (at most 60 times). Wait until a StudioComponent is Ready. Use this after invoking CreateStudioComponent or UpdateStudioComponent
*/
waitFor(state: "studioComponentReady", params: Nimble.Types.GetStudioComponentRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Waits for the studioComponentReady state by periodically calling the underlying Nimble.getStudioComponentoperation every 2 seconds (at most 60 times). Wait until a StudioComponent is Ready. Use this after invoking CreateStudioComponent or UpdateStudioComponent
*/
waitFor(state: "studioComponentReady", callback?: (err: AWSError, data: Nimble.Types.GetStudioComponentResponse) => void): Request<Nimble.Types.GetStudioComponentResponse, AWSError>;
/**
* Waits for the studioDeleted state by periodically calling the underlying Nimble.getStudiooperation every 2 seconds (at most 60 times). Wait until a Studio is Deleted. Use this after invoking DeleteStudio.
*/
waitFor(state: "studioDeleted", params: Nimble.Types.GetStudioRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
/**
* Waits for the studioDeleted state by periodically calling the underlying Nimble.getStudiooperation every 2 seconds (at most 60 times). Wait until a Studio is Deleted. Use this after invoking DeleteStudio.
*/
waitFor(state: "studioDeleted", callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
/**
* Waits for the studioReady state by periodically calling the underlying Nimble.getStudiooperation every 2 seconds (at most 60 times). Wait until a Studio is Ready. Use this after invoking CreateStudio, UpdateStudio, or StartStudioSSOConfigurationRepair
*/
waitFor(state: "studioReady", params: Nimble.Types.GetStudioRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
/**
* Waits for the studioReady state by periodically calling the underlying Nimble.getStudiooperation every 2 seconds (at most 60 times). Wait until a Studio is Ready. Use this after invoking CreateStudio, UpdateStudio, or StartStudioSSOConfigurationRepair
*/
waitFor(state: "studioReady", callback?: (err: AWSError, data: Nimble.Types.GetStudioResponse) => void): Request<Nimble.Types.GetStudioResponse, AWSError>;
}
declare namespace Nimble {
export interface AcceptEulasRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
*/
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 type AutomaticTerminationMode = "DEACTIVATED"|"ACTIVATED"|string;
export type ClientToken = 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?: SensitiveString;
}
export interface CreateLaunchProfileRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
*/
clientToken?: ClientToken;
/**
* The description.
*/
description?: LaunchProfileDescription;
/**
* Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
*/
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 {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
*/
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 {
/**
* The streaming image.
*/
streamingImage?: StreamingImage;
}
export interface CreateStreamingSessionRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
*/
clientToken?: ClientToken;
/**
* The EC2 Instance type used for the streaming session.
*/
ec2InstanceType?: StreamingInstanceType;
/**
* 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. The user that owns the session will be logging into the session and interacting with the virtual workstation.
*/
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