Nimble

import { Nimble } from "https://aws-api.deno.dev/v0.4/services/nimble.ts?docs=full";

class Nimble {

constructor(apiFactory: client.ApiFactory);

async acceptEulas(params: AcceptEulasRequest, opts?: client.RequestOptions): Promise<AcceptEulasResponse>;

async createLaunchProfile(params: CreateLaunchProfileRequest, opts?: client.RequestOptions): Promise<CreateLaunchProfileResponse>;

async createStreamingImage(params: CreateStreamingImageRequest, opts?: client.RequestOptions): Promise<CreateStreamingImageResponse>;

async createStreamingSession(params: CreateStreamingSessionRequest, opts?: client.RequestOptions): Promise<CreateStreamingSessionResponse>;

async createStreamingSessionStream(params: CreateStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<CreateStreamingSessionStreamResponse>;

async createStudio(params: CreateStudioRequest, opts?: client.RequestOptions): Promise<CreateStudioResponse>;

async createStudioComponent(params: CreateStudioComponentRequest, opts?: client.RequestOptions): Promise<CreateStudioComponentResponse>;

async deleteLaunchProfile(params: DeleteLaunchProfileRequest, opts?: client.RequestOptions): Promise<DeleteLaunchProfileResponse>;

async deleteLaunchProfileMember(params: DeleteLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStreamingImage(params: DeleteStreamingImageRequest, opts?: client.RequestOptions): Promise<DeleteStreamingImageResponse>;

async deleteStreamingSession(params: DeleteStreamingSessionRequest, opts?: client.RequestOptions): Promise<DeleteStreamingSessionResponse>;

async deleteStudio(params: DeleteStudioRequest, opts?: client.RequestOptions): Promise<DeleteStudioResponse>;

async deleteStudioComponent(params: DeleteStudioComponentRequest, opts?: client.RequestOptions): Promise<DeleteStudioComponentResponse>;

async deleteStudioMember(params: DeleteStudioMemberRequest, opts?: client.RequestOptions): Promise<void>;

async getEula(params: GetEulaRequest, opts?: client.RequestOptions): Promise<GetEulaResponse>;

async getLaunchProfile(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>;

async getLaunchProfileDetails(params: GetLaunchProfileDetailsRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileDetailsResponse>;

async getLaunchProfileInitialization(params: GetLaunchProfileInitializationRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileInitializationResponse>;

async getLaunchProfileMember(params: GetLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileMemberResponse>;

async getStreamingImage(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>;

async getStreamingSession(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>;

async getStreamingSessionBackup(params: GetStreamingSessionBackupRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionBackupResponse>;

async getStreamingSessionStream(params: GetStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionStreamResponse>;

async getStudio(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>;

async getStudioComponent(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>;

async getStudioMember(params: GetStudioMemberRequest, opts?: client.RequestOptions): Promise<GetStudioMemberResponse>;

async listEulaAcceptances(params: ListEulaAcceptancesRequest, opts?: client.RequestOptions): Promise<ListEulaAcceptancesResponse>;

async listEulas(params?: ListEulasRequest, opts?: client.RequestOptions): Promise<ListEulasResponse>;

async listLaunchProfileMembers(params: ListLaunchProfileMembersRequest, opts?: client.RequestOptions): Promise<ListLaunchProfileMembersResponse>;

async listLaunchProfiles(params: ListLaunchProfilesRequest, opts?: client.RequestOptions): Promise<ListLaunchProfilesResponse>;

async listStreamingImages(params: ListStreamingImagesRequest, opts?: client.RequestOptions): Promise<ListStreamingImagesResponse>;

async listStreamingSessionBackups(params: ListStreamingSessionBackupsRequest, opts?: client.RequestOptions): Promise<ListStreamingSessionBackupsResponse>;

async listStreamingSessions(params: ListStreamingSessionsRequest, opts?: client.RequestOptions): Promise<ListStreamingSessionsResponse>;

async listStudioComponents(params: ListStudioComponentsRequest, opts?: client.RequestOptions): Promise<ListStudioComponentsResponse>;

async listStudioMembers(params: ListStudioMembersRequest, opts?: client.RequestOptions): Promise<ListStudioMembersResponse>;

async listStudios(params?: ListStudiosRequest, opts?: client.RequestOptions): Promise<ListStudiosResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putLaunchProfileMembers(params: PutLaunchProfileMembersRequest, opts?: client.RequestOptions): Promise<void>;

async putStudioMembers(params: PutStudioMembersRequest, opts?: client.RequestOptions): Promise<void>;

async startStreamingSession(params: StartStreamingSessionRequest, opts?: client.RequestOptions): Promise<StartStreamingSessionResponse>;

async startStudioSSOConfigurationRepair(params: StartStudioSSOConfigurationRepairRequest, opts?: client.RequestOptions): Promise<StartStudioSSOConfigurationRepairResponse>;

async stopStreamingSession(params: StopStreamingSessionRequest, opts?: client.RequestOptions): Promise<StopStreamingSessionResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateLaunchProfile(params: UpdateLaunchProfileRequest, opts?: client.RequestOptions): Promise<UpdateLaunchProfileResponse>;

async updateLaunchProfileMember(params: UpdateLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<UpdateLaunchProfileMemberResponse>;

async updateStreamingImage(params: UpdateStreamingImageRequest, opts?: client.RequestOptions): Promise<UpdateStreamingImageResponse>;

async updateStudio(params: UpdateStudioRequest, opts?: client.RequestOptions): Promise<UpdateStudioResponse>;

async updateStudioComponent(params: UpdateStudioComponentRequest, opts?: client.RequestOptions): Promise<UpdateStudioComponentResponse>;

async waitForLaunchProfileDeleted(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>;

async waitForLaunchProfileReady(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>;

async waitForStreamingImageDeleted(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>;

async waitForStreamingImageReady(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>;

async waitForStreamingSessionDeleted(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>;

async waitForStreamingSessionReady(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>;

async waitForStreamingSessionStopped(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>;

async waitForStreamingSessionStreamReady(params: GetStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionStreamResponse>;

async waitForStudioComponentDeleted(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>;

async waitForStudioComponentReady(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>;

async waitForStudioDeleted(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>;

async waitForStudioReady(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Nimble(apiFactory: client.ApiFactory)

[src]

§Methods

acceptEulas(params: AcceptEulasRequest, opts?: client.RequestOptions): Promise<AcceptEulasResponse>

[src]

Accept EULAs.

createLaunchProfile(params: CreateLaunchProfileRequest, opts?: client.RequestOptions): Promise<CreateLaunchProfileResponse>

[src]

Create a launch profile.

createStreamingImage(params: CreateStreamingImageRequest, opts?: client.RequestOptions): Promise<CreateStreamingImageResponse>

[src]

Creates a streaming image resource in a studio.

createStreamingSession(params: CreateStreamingSessionRequest, opts?: client.RequestOptions): Promise<CreateStreamingSessionResponse>

[src]

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.

createStreamingSessionStream(params: CreateStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<CreateStreamingSessionStreamResponse>

[src]

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.

createStudio(params: CreateStudioRequest, opts?: client.RequestOptions): Promise<CreateStudioResponse>

[src]

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.

createStudioComponent(params: CreateStudioComponentRequest, opts?: client.RequestOptions): Promise<CreateStudioComponentResponse>

[src]

Creates a studio component resource.

deleteLaunchProfile(params: DeleteLaunchProfileRequest, opts?: client.RequestOptions): Promise<DeleteLaunchProfileResponse>

[src]

Permanently delete a launch profile.

deleteLaunchProfileMember(params: DeleteLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a user from launch profile membership.

deleteStreamingImage(params: DeleteStreamingImageRequest, opts?: client.RequestOptions): Promise<DeleteStreamingImageResponse>

[src]

Delete streaming image.

deleteStreamingSession(params: DeleteStreamingSessionRequest, opts?: client.RequestOptions): Promise<DeleteStreamingSessionResponse>

[src]

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.

deleteStudio(params: DeleteStudioRequest, opts?: client.RequestOptions): Promise<DeleteStudioResponse>

[src]

Delete a studio resource.

deleteStudioComponent(params: DeleteStudioComponentRequest, opts?: client.RequestOptions): Promise<DeleteStudioComponentResponse>

[src]

Deletes a studio component resource.

deleteStudioMember(params: DeleteStudioMemberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a user from studio membership.

getEula(params: GetEulaRequest, opts?: client.RequestOptions): Promise<GetEulaResponse>

[src]

Get EULA.

getLaunchProfile(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>

[src]

Get a launch profile.

getLaunchProfileDetails(params: GetLaunchProfileDetailsRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileDetailsResponse>

[src]

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.

getLaunchProfileInitialization(params: GetLaunchProfileInitializationRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileInitializationResponse>

[src]

Get a launch profile initialization.

getLaunchProfileMember(params: GetLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileMemberResponse>

[src]

Get a user persona in launch profile membership.

getStreamingImage(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>

[src]

Get streaming image.

getStreamingSession(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>

[src]

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

getStreamingSessionBackup(params: GetStreamingSessionBackupRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionBackupResponse>

[src]

Gets StreamingSessionBackup resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

getStreamingSessionStream(params: GetStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionStreamResponse>

[src]

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.

getStudio(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>

[src]

Get a studio resource.

getStudioComponent(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>

[src]

Gets a studio component resource.

getStudioMember(params: GetStudioMemberRequest, opts?: client.RequestOptions): Promise<GetStudioMemberResponse>

[src]

Get a user's membership in a studio.

listEulaAcceptances(params: ListEulaAcceptancesRequest, opts?: client.RequestOptions): Promise<ListEulaAcceptancesResponse>

[src]

List EULA acceptances.

listEulas(params?: ListEulasRequest, opts?: client.RequestOptions): Promise<ListEulasResponse>

[src]

List EULAs.

listLaunchProfileMembers(params: ListLaunchProfileMembersRequest, opts?: client.RequestOptions): Promise<ListLaunchProfileMembersResponse>

[src]

Get all users in a given launch profile membership.

listLaunchProfiles(params: ListLaunchProfilesRequest, opts?: client.RequestOptions): Promise<ListLaunchProfilesResponse>

[src]

List all the launch profiles a studio.

listStreamingImages(params: ListStreamingImagesRequest, opts?: client.RequestOptions): Promise<ListStreamingImagesResponse>

[src]

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.

listStreamingSessionBackups(params: ListStreamingSessionBackupsRequest, opts?: client.RequestOptions): Promise<ListStreamingSessionBackupsResponse>

[src]

Lists the backups of a streaming session in a studio.

listStreamingSessions(params: ListStreamingSessionsRequest, opts?: client.RequestOptions): Promise<ListStreamingSessionsResponse>

[src]

Lists the streaming sessions in a studio.

listStudioComponents(params: ListStudioComponentsRequest, opts?: client.RequestOptions): Promise<ListStudioComponentsResponse>

[src]

Lists the StudioComponents in a studio.

listStudioMembers(params: ListStudioMembersRequest, opts?: client.RequestOptions): Promise<ListStudioMembersResponse>

[src]

Get all users in a given studio membership.

Note: ListStudioMembers only returns admin members.

listStudios(params?: ListStudiosRequest, opts?: client.RequestOptions): Promise<ListStudiosResponse>

[src]

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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.

putLaunchProfileMembers(params: PutLaunchProfileMembersRequest, opts?: client.RequestOptions): Promise<void>

[src]

Add/update users with given persona to launch profile membership.

putStudioMembers(params: PutStudioMembersRequest, opts?: client.RequestOptions): Promise<void>

[src]

Add/update users with given persona to studio membership.

startStreamingSession(params: StartStreamingSessionRequest, opts?: client.RequestOptions): Promise<StartStreamingSessionResponse>

[src]

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.

startStudioSSOConfigurationRepair(params: StartStudioSSOConfigurationRepairRequest, opts?: client.RequestOptions): Promise<StartStudioSSOConfigurationRepairResponse>

[src]

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.

stopStreamingSession(params: StopStreamingSessionRequest, opts?: client.RequestOptions): Promise<StopStreamingSessionResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates tags for a resource, given its ARN.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the tags for a resource.

updateLaunchProfile(params: UpdateLaunchProfileRequest, opts?: client.RequestOptions): Promise<UpdateLaunchProfileResponse>

[src]

Update a launch profile.

updateLaunchProfileMember(params: UpdateLaunchProfileMemberRequest, opts?: client.RequestOptions): Promise<UpdateLaunchProfileMemberResponse>

[src]

Update a user persona in launch profile membership.

updateStreamingImage(params: UpdateStreamingImageRequest, opts?: client.RequestOptions): Promise<UpdateStreamingImageResponse>

[src]

Update streaming image.

updateStudio(params: UpdateStudioRequest, opts?: client.RequestOptions): Promise<UpdateStudioResponse>

[src]

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

updateStudioComponent(params: UpdateStudioComponentRequest, opts?: client.RequestOptions): Promise<UpdateStudioComponentResponse>

[src]

Updates a studio component resource.

waitForLaunchProfileDeleted(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>

[src]

Wait until a LaunchProfile is Deleted. Use this after invoking DeleteLaunchProfile Checks state up to 150 times, 5 seconds apart (about 13 minutes max wait time).

waitForLaunchProfileReady(params: GetLaunchProfileRequest, opts?: client.RequestOptions): Promise<GetLaunchProfileResponse>

[src]

Wait until a LaunchProfile is Ready. Use this after invoking CreateLaunchProfile or UpdateLaunchProfile Checks state up to 150 times, 5 seconds apart (about 13 minutes max wait time).

waitForStreamingImageDeleted(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>

[src]

Wait until a StreamingImage Deleted. Use this after invoking DeleteStreamingImage Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

waitForStreamingImageReady(params: GetStreamingImageRequest, opts?: client.RequestOptions): Promise<GetStreamingImageResponse>

[src]

Wait until a StreamingImage is Ready. Use this after invoking CreateStreamingImage or UpdateStreamingImage Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

waitForStreamingSessionDeleted(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>

[src]

Wait until a StreamingSessionDeleted. Use this after invoking DeleteStreamingSession Checks state up to 180 times, 5 seconds apart (about 15 minutes max wait time).

waitForStreamingSessionReady(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>

[src]

Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession Checks state up to 180 times, 10 seconds apart (about 30 minutes max wait time).

waitForStreamingSessionStopped(params: GetStreamingSessionRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionResponse>

[src]

Wait until a StreamingSessionStopped. Use this after invoking StopStreamingSession Checks state up to 180 times, 5 seconds apart (about 15 minutes max wait time).

waitForStreamingSessionStreamReady(params: GetStreamingSessionStreamRequest, opts?: client.RequestOptions): Promise<GetStreamingSessionStreamResponse>

[src]

Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream Checks state up to 30 times, 5 seconds apart (about 3 minutes max wait time).

waitForStudioComponentDeleted(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>

[src]

Wait until a StudioComponent Deleted. Use this after invoking DeleteStudioComponent Checks state up to 120 times, 1 seconds apart (about 2 minutes max wait time).

waitForStudioComponentReady(params: GetStudioComponentRequest, opts?: client.RequestOptions): Promise<GetStudioComponentResponse>

[src]

Wait until a StudioComponent is Ready. Use this after invoking CreateStudioComponent or UpdateStudioComponent Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

waitForStudioDeleted(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>

[src]

Wait until a Studio is Deleted. Use this after invoking DeleteStudio. Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

waitForStudioReady(params: GetStudioRequest, opts?: client.RequestOptions): Promise<GetStudioResponse>

[src]

Wait until a Studio is Ready. Use this after invoking CreateStudio, UpdateStudio, or StartStudioSSOConfigurationRepair Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]