nimble/aws.sdk.kotlin.services.nimble/NimbleClient

NimbleClient

interface NimbleClient : SdkClient

Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.

Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.

Properties

Link copied to clipboard
abstract override val config: NimbleClient.Config

NimbleClient's configuration

Functions

Link copied to clipboard
abstract suspend fun acceptEulas(input: AcceptEulasRequest): AcceptEulasResponse

Accept EULAs.

Link copied to clipboard
abstract suspend fun createLaunchProfile(input: CreateLaunchProfileRequest): CreateLaunchProfileResponse

Create a launch profile.

Link copied to clipboard
abstract suspend fun createStreamingImage(input: CreateStreamingImageRequest): CreateStreamingImageResponse

Creates a streaming image resource in a studio.

Link copied to clipboard
abstract suspend fun createStreamingSession(input: CreateStreamingSessionRequest): CreateStreamingSessionResponse

Creates a streaming session in a studio.

Link copied to clipboard
abstract suspend fun createStreamingSessionStream(input: CreateStreamingSessionStreamRequest): CreateStreamingSessionStreamResponse

Creates a streaming session stream for a streaming session.

Link copied to clipboard
abstract suspend fun createStudio(input: CreateStudioRequest): CreateStudioResponse

Create a new studio.

Link copied to clipboard
abstract suspend fun createStudioComponent(input: CreateStudioComponentRequest): CreateStudioComponentResponse

Creates a studio component resource.

Link copied to clipboard
abstract suspend fun deleteLaunchProfile(input: DeleteLaunchProfileRequest): DeleteLaunchProfileResponse

Permanently delete a launch profile.

Link copied to clipboard
abstract suspend fun deleteLaunchProfileMember(input: DeleteLaunchProfileMemberRequest): DeleteLaunchProfileMemberResponse

Delete a user from launch profile membership.

Link copied to clipboard
abstract suspend fun deleteStreamingImage(input: DeleteStreamingImageRequest): DeleteStreamingImageResponse

Delete streaming image.

Link copied to clipboard
abstract suspend fun deleteStreamingSession(input: DeleteStreamingSessionRequest): DeleteStreamingSessionResponse

Deletes streaming session resource.

Link copied to clipboard
abstract suspend fun deleteStudio(input: DeleteStudioRequest): DeleteStudioResponse

Delete a studio resource.

Link copied to clipboard
abstract suspend fun deleteStudioComponent(input: DeleteStudioComponentRequest): DeleteStudioComponentResponse

Deletes a studio component resource.

Link copied to clipboard
abstract suspend fun deleteStudioMember(input: DeleteStudioMemberRequest): DeleteStudioMemberResponse

Delete a user from studio membership.

Link copied to clipboard
abstract suspend fun getEula(input: GetEulaRequest): GetEulaResponse

Get EULA.

Link copied to clipboard
abstract suspend fun getLaunchProfile(input: GetLaunchProfileRequest): GetLaunchProfileResponse

Get a launch profile.

Link copied to clipboard
abstract suspend fun getLaunchProfileDetails(input: GetLaunchProfileDetailsRequest): GetLaunchProfileDetailsResponse

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.

Link copied to clipboard
abstract suspend fun getLaunchProfileInitialization(input: GetLaunchProfileInitializationRequest): GetLaunchProfileInitializationResponse

Get a launch profile initialization.

Link copied to clipboard
abstract suspend fun getLaunchProfileMember(input: GetLaunchProfileMemberRequest): GetLaunchProfileMemberResponse

Get a user persona in launch profile membership.

Link copied to clipboard
abstract suspend fun getStreamingImage(input: GetStreamingImageRequest): GetStreamingImageResponse

Get streaming image.

Link copied to clipboard
abstract suspend fun getStreamingSession(input: GetStreamingSessionRequest): GetStreamingSessionResponse

Gets StreamingSession resource.

Link copied to clipboard
abstract suspend fun getStreamingSessionBackup(input: GetStreamingSessionBackupRequest): GetStreamingSessionBackupResponse

Gets StreamingSessionBackup resource.

Link copied to clipboard
abstract suspend fun getStreamingSessionStream(input: GetStreamingSessionStreamRequest): GetStreamingSessionStreamResponse

Gets a StreamingSessionStream for a streaming session.

Link copied to clipboard
abstract suspend fun getStudio(input: GetStudioRequest): GetStudioResponse

Get a studio resource.

Link copied to clipboard
abstract suspend fun getStudioComponent(input: GetStudioComponentRequest): GetStudioComponentResponse

Gets a studio component resource.

Link copied to clipboard
abstract suspend fun getStudioMember(input: GetStudioMemberRequest): GetStudioMemberResponse

Get a user's membership in a studio.

Link copied to clipboard
abstract suspend fun listEulaAcceptances(input: ListEulaAcceptancesRequest): ListEulaAcceptancesResponse

List EULA acceptances.

Link copied to clipboard
abstract suspend fun listEulas(input: ListEulasRequest = ListEulasRequest { }): ListEulasResponse

List EULAs.

Link copied to clipboard
abstract suspend fun listLaunchProfileMembers(input: ListLaunchProfileMembersRequest): ListLaunchProfileMembersResponse

Get all users in a given launch profile membership.

Link copied to clipboard
abstract suspend fun listLaunchProfiles(input: ListLaunchProfilesRequest): ListLaunchProfilesResponse

List all the launch profiles a studio.

Link copied to clipboard
abstract suspend fun listStreamingImages(input: ListStreamingImagesRequest): ListStreamingImagesResponse

List the streaming image resources available to this studio.

Link copied to clipboard
abstract suspend fun listStreamingSessionBackups(input: ListStreamingSessionBackupsRequest): ListStreamingSessionBackupsResponse

Lists the backups of a streaming session in a studio.

Link copied to clipboard
abstract suspend fun listStreamingSessions(input: ListStreamingSessionsRequest): ListStreamingSessionsResponse

Lists the streaming sessions in a studio.

Link copied to clipboard
abstract suspend fun listStudioComponents(input: ListStudioComponentsRequest): ListStudioComponentsResponse

Lists the StudioComponents in a studio.

Link copied to clipboard
abstract suspend fun listStudioMembers(input: ListStudioMembersRequest): ListStudioMembersResponse

Get all users in a given studio membership.

Link copied to clipboard
abstract suspend fun listStudios(input: ListStudiosRequest = ListStudiosRequest { }): ListStudiosResponse

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

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Gets the tags for a resource, given its Amazon Resource Names (ARN).

Link copied to clipboard
abstract suspend fun putLaunchProfileMembers(input: PutLaunchProfileMembersRequest): PutLaunchProfileMembersResponse

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

Link copied to clipboard
abstract suspend fun putStudioMembers(input: PutStudioMembersRequest): PutStudioMembersResponse

Add/update users with given persona to studio membership.

Link copied to clipboard
abstract suspend fun startStreamingSession(input: StartStreamingSessionRequest): StartStreamingSessionResponse

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.

Link copied to clipboard
abstract suspend fun startStudioSsoConfigurationRepair(input: StartStudioSsoConfigurationRepairRequest): StartStudioSsoConfigurationRepairResponse

Repairs the IAM Identity Center configuration for a given studio.

Link copied to clipboard
abstract suspend fun stopStreamingSession(input: StopStreamingSessionRequest): StopStreamingSessionResponse

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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Creates tags for a resource, given its ARN.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes the tags for a resource.

Link copied to clipboard
abstract suspend fun updateLaunchProfile(input: UpdateLaunchProfileRequest): UpdateLaunchProfileResponse

Update a launch profile.

Link copied to clipboard
abstract suspend fun updateLaunchProfileMember(input: UpdateLaunchProfileMemberRequest): UpdateLaunchProfileMemberResponse

Update a user persona in launch profile membership.

Link copied to clipboard
abstract suspend fun updateStreamingImage(input: UpdateStreamingImageRequest): UpdateStreamingImageResponse

Update streaming image.

Link copied to clipboard
abstract suspend fun updateStudio(input: UpdateStudioRequest): UpdateStudioResponse

Update a Studio resource.

Link copied to clipboard
abstract suspend fun updateStudioComponent(input: UpdateStudioComponentRequest): UpdateStudioComponentResponse

Updates a studio component resource.

Inherited functions

Link copied to clipboard
inline suspend fun NimbleClient.acceptEulas(crossinline block: AcceptEulasRequest.Builder.() -> Unit): AcceptEulasResponse

Accept EULAs.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun NimbleClient.createLaunchProfile(crossinline block: CreateLaunchProfileRequest.Builder.() -> Unit): CreateLaunchProfileResponse

Create a launch profile.

Link copied to clipboard
inline suspend fun NimbleClient.createStreamingImage(crossinline block: CreateStreamingImageRequest.Builder.() -> Unit): CreateStreamingImageResponse

Creates a streaming image resource in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.createStreamingSession(crossinline block: CreateStreamingSessionRequest.Builder.() -> Unit): CreateStreamingSessionResponse

Creates a streaming session in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.createStreamingSessionStream(crossinline block: CreateStreamingSessionStreamRequest.Builder.() -> Unit): CreateStreamingSessionStreamResponse

Creates a streaming session stream for a streaming session.

Link copied to clipboard
inline suspend fun NimbleClient.createStudio(crossinline block: CreateStudioRequest.Builder.() -> Unit): CreateStudioResponse

Create a new studio.

Link copied to clipboard
inline suspend fun NimbleClient.createStudioComponent(crossinline block: CreateStudioComponentRequest.Builder.() -> Unit): CreateStudioComponentResponse

Creates a studio component resource.

Link copied to clipboard
inline suspend fun NimbleClient.deleteLaunchProfile(crossinline block: DeleteLaunchProfileRequest.Builder.() -> Unit): DeleteLaunchProfileResponse

Permanently delete a launch profile.

Link copied to clipboard
inline suspend fun NimbleClient.deleteLaunchProfileMember(crossinline block: DeleteLaunchProfileMemberRequest.Builder.() -> Unit): DeleteLaunchProfileMemberResponse

Delete a user from launch profile membership.

Link copied to clipboard
inline suspend fun NimbleClient.deleteStreamingImage(crossinline block: DeleteStreamingImageRequest.Builder.() -> Unit): DeleteStreamingImageResponse

Delete streaming image.

Link copied to clipboard
inline suspend fun NimbleClient.deleteStreamingSession(crossinline block: DeleteStreamingSessionRequest.Builder.() -> Unit): DeleteStreamingSessionResponse

Deletes streaming session resource.

Link copied to clipboard
inline suspend fun NimbleClient.deleteStudio(crossinline block: DeleteStudioRequest.Builder.() -> Unit): DeleteStudioResponse

Delete a studio resource.

Link copied to clipboard
inline suspend fun NimbleClient.deleteStudioComponent(crossinline block: DeleteStudioComponentRequest.Builder.() -> Unit): DeleteStudioComponentResponse

Deletes a studio component resource.

Link copied to clipboard
inline suspend fun NimbleClient.deleteStudioMember(crossinline block: DeleteStudioMemberRequest.Builder.() -> Unit): DeleteStudioMemberResponse

Delete a user from studio membership.

Link copied to clipboard
inline suspend fun NimbleClient.getEula(crossinline block: GetEulaRequest.Builder.() -> Unit): GetEulaResponse

Get EULA.

Link copied to clipboard
inline suspend fun NimbleClient.getLaunchProfile(crossinline block: GetLaunchProfileRequest.Builder.() -> Unit): GetLaunchProfileResponse

Get a launch profile.

Link copied to clipboard
inline suspend fun NimbleClient.getLaunchProfileDetails(crossinline block: GetLaunchProfileDetailsRequest.Builder.() -> Unit): GetLaunchProfileDetailsResponse

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.

Link copied to clipboard
inline suspend fun NimbleClient.getLaunchProfileInitialization(crossinline block: GetLaunchProfileInitializationRequest.Builder.() -> Unit): GetLaunchProfileInitializationResponse

Get a launch profile initialization.

Link copied to clipboard
inline suspend fun NimbleClient.getLaunchProfileMember(crossinline block: GetLaunchProfileMemberRequest.Builder.() -> Unit): GetLaunchProfileMemberResponse

Get a user persona in launch profile membership.

Link copied to clipboard
inline suspend fun NimbleClient.getStreamingImage(crossinline block: GetStreamingImageRequest.Builder.() -> Unit): GetStreamingImageResponse

Get streaming image.

Link copied to clipboard
inline suspend fun NimbleClient.getStreamingSession(crossinline block: GetStreamingSessionRequest.Builder.() -> Unit): GetStreamingSessionResponse

Gets StreamingSession resource.

Link copied to clipboard
inline suspend fun NimbleClient.getStreamingSessionBackup(crossinline block: GetStreamingSessionBackupRequest.Builder.() -> Unit): GetStreamingSessionBackupResponse

Gets StreamingSessionBackup resource.

Link copied to clipboard
inline suspend fun NimbleClient.getStreamingSessionStream(crossinline block: GetStreamingSessionStreamRequest.Builder.() -> Unit): GetStreamingSessionStreamResponse

Gets a StreamingSessionStream for a streaming session.

Link copied to clipboard
inline suspend fun NimbleClient.getStudio(crossinline block: GetStudioRequest.Builder.() -> Unit): GetStudioResponse

Get a studio resource.

Link copied to clipboard
inline suspend fun NimbleClient.getStudioComponent(crossinline block: GetStudioComponentRequest.Builder.() -> Unit): GetStudioComponentResponse

Gets a studio component resource.

Link copied to clipboard
inline suspend fun NimbleClient.getStudioMember(crossinline block: GetStudioMemberRequest.Builder.() -> Unit): GetStudioMemberResponse

Get a user's membership in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.listEulaAcceptances(crossinline block: ListEulaAcceptancesRequest.Builder.() -> Unit): ListEulaAcceptancesResponse

List EULA acceptances.

Link copied to clipboard
inline suspend fun NimbleClient.listEulas(crossinline block: ListEulasRequest.Builder.() -> Unit): ListEulasResponse

List EULAs.

Link copied to clipboard
inline suspend fun NimbleClient.listLaunchProfileMembers(crossinline block: ListLaunchProfileMembersRequest.Builder.() -> Unit): ListLaunchProfileMembersResponse

Get all users in a given launch profile membership.

Link copied to clipboard
inline suspend fun NimbleClient.listLaunchProfiles(crossinline block: ListLaunchProfilesRequest.Builder.() -> Unit): ListLaunchProfilesResponse

List all the launch profiles a studio.

Link copied to clipboard
inline suspend fun NimbleClient.listStreamingImages(crossinline block: ListStreamingImagesRequest.Builder.() -> Unit): ListStreamingImagesResponse

List the streaming image resources available to this studio.

Link copied to clipboard
inline suspend fun NimbleClient.listStreamingSessionBackups(crossinline block: ListStreamingSessionBackupsRequest.Builder.() -> Unit): ListStreamingSessionBackupsResponse

Lists the backups of a streaming session in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.listStreamingSessions(crossinline block: ListStreamingSessionsRequest.Builder.() -> Unit): ListStreamingSessionsResponse

Lists the streaming sessions in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.listStudioComponents(crossinline block: ListStudioComponentsRequest.Builder.() -> Unit): ListStudioComponentsResponse

Lists the StudioComponents in a studio.

Link copied to clipboard
inline suspend fun NimbleClient.listStudioMembers(crossinline block: ListStudioMembersRequest.Builder.() -> Unit): ListStudioMembersResponse

Get all users in a given studio membership.

Link copied to clipboard
inline suspend fun NimbleClient.listStudios(crossinline block: ListStudiosRequest.Builder.() -> Unit): ListStudiosResponse

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

Link copied to clipboard
inline suspend fun NimbleClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets the tags for a resource, given its Amazon Resource Names (ARN).

Link copied to clipboard
inline suspend fun NimbleClient.putLaunchProfileMembers(crossinline block: PutLaunchProfileMembersRequest.Builder.() -> Unit): PutLaunchProfileMembersResponse

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

Link copied to clipboard
inline suspend fun NimbleClient.putStudioMembers(crossinline block: PutStudioMembersRequest.Builder.() -> Unit): PutStudioMembersResponse

Add/update users with given persona to studio membership.

Link copied to clipboard
inline suspend fun NimbleClient.startStreamingSession(crossinline block: StartStreamingSessionRequest.Builder.() -> Unit): StartStreamingSessionResponse

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.

Link copied to clipboard
inline suspend fun NimbleClient.startStudioSsoConfigurationRepair(crossinline block: StartStudioSsoConfigurationRepairRequest.Builder.() -> Unit): StartStudioSsoConfigurationRepairResponse

Repairs the IAM Identity Center configuration for a given studio.

Link copied to clipboard
inline suspend fun NimbleClient.stopStreamingSession(crossinline block: StopStreamingSessionRequest.Builder.() -> Unit): StopStreamingSessionResponse

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.

Link copied to clipboard
inline suspend fun NimbleClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Creates tags for a resource, given its ARN.

Link copied to clipboard
inline suspend fun NimbleClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes the tags for a resource.

Link copied to clipboard
inline suspend fun NimbleClient.updateLaunchProfile(crossinline block: UpdateLaunchProfileRequest.Builder.() -> Unit): UpdateLaunchProfileResponse

Update a launch profile.

Link copied to clipboard
inline suspend fun NimbleClient.updateLaunchProfileMember(crossinline block: UpdateLaunchProfileMemberRequest.Builder.() -> Unit): UpdateLaunchProfileMemberResponse

Update a user persona in launch profile membership.

Link copied to clipboard
inline suspend fun NimbleClient.updateStreamingImage(crossinline block: UpdateStreamingImageRequest.Builder.() -> Unit): UpdateStreamingImageResponse

Update streaming image.

Link copied to clipboard
inline suspend fun NimbleClient.updateStudio(crossinline block: UpdateStudioRequest.Builder.() -> Unit): UpdateStudioResponse

Update a Studio resource.

Link copied to clipboard
inline suspend fun NimbleClient.updateStudioComponent(crossinline block: UpdateStudioComponentRequest.Builder.() -> Unit): UpdateStudioComponentResponse

Updates a studio component resource.

Link copied to clipboard
fun NimbleClient.withConfig(block: NimbleClient.Config.Builder.() -> Unit): NimbleClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.