Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Nimble

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.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of NimbleClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

acceptEulas

createLaunchProfile

createStreamingImage

createStreamingSession

createStreamingSessionStream

createStudio

  • 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.

    Parameters

    Returns Promise<CreateStudioCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: CreateStudioCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateStudioCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

createStudioComponent

deleteLaunchProfile

deleteLaunchProfileMember

deleteStreamingImage

deleteStreamingSession

deleteStudio

deleteStudioComponent

deleteStudioMember

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getEula

getLaunchProfile

getLaunchProfileDetails

  • 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.

    Parameters

    Returns Promise<GetLaunchProfileDetailsCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: GetLaunchProfileDetailsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetLaunchProfileDetailsCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

getLaunchProfileInitialization

getLaunchProfileMember

getStreamingImage

getStreamingSession

getStreamingSessionStream

getStudio

getStudioComponent

getStudioMember

listEulaAcceptances

listEulas

listLaunchProfileMembers

listLaunchProfiles

listStreamingImages

listStreamingSessions

listStudioComponents

listStudioMembers

listStudios

listTagsForResource

  • 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.

    Parameters

    Returns Promise<ListTagsForResourceCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: ListTagsForResourceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListTagsForResourceCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

putLaunchProfileMembers

putStudioMembers

send

startStreamingSession

startStudioSSOConfigurationRepair

  • 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.

    Parameters

    Returns Promise<StartStudioSSOConfigurationRepairCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: StartStudioSSOConfigurationRepairCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<StartStudioSSOConfigurationRepairCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

stopStreamingSession

tagResource

untagResource

updateLaunchProfile

updateLaunchProfileMember

updateStreamingImage

updateStudio

updateStudioComponent