amazonaws.com – 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.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:nimble/2020-08-01.json
- Provider
- amazonaws.com:nimble / nimble
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/nimble/2020-08-01/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/nimble/2020-08-01/openapi.yaml
Tools (51)
Extracted live via the executor SDK.
-
20200801.acceptEulasAccept EULAs.
-
20200801.createLaunchProfileCreate a launch profile.
-
20200801.createStreamingImageCreates a streaming image resource in a studio.
-
20200801.createStreamingSessionCreates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the
READYstate. -
20200801.createStreamingSessionStreamCreates 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
READYstate. -
20200801.createStudioCreate 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-StudioUsermanaged policy attached for the portal to function properly.The admin role must have the
AmazonNimbleStudio-StudioAdminmanaged 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
CreateStudioto 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.
-
20200801.createStudioComponentCreates a studio component resource.
-
20200801.deleteLaunchProfilePermanently delete a launch profile.
-
20200801.deleteLaunchProfileMemberDelete a user from launch profile membership.
-
20200801.deleteStreamingImageDelete streaming image.
-
20200801.deleteStreamingSessionDeletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a
DELETEDstate.A streaming session will count against your streaming session quota until it is marked
DELETED. -
20200801.deleteStudioDelete a studio resource.
-
20200801.deleteStudioComponentDeletes a studio component resource.
-
20200801.deleteStudioMemberDelete a user from studio membership.
-
20200801.getEulaGet EULA.
-
20200801.getLaunchProfileGet a launch profile.
-
20200801.getLaunchProfileDetailsLaunch 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.
-
20200801.getLaunchProfileInitializationGet a launch profile initialization.
-
20200801.getLaunchProfileMemberGet a user persona in launch profile membership.
-
20200801.getStreamingImageGet streaming image.
-
20200801.getStreamingSessionGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
-
20200801.getStreamingSessionBackupGets
StreamingSessionBackupresource.Invoke this operation to poll for a streaming session backup while stopping a streaming session.
-
20200801.getStreamingSessionStreamGets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking
CreateStreamingSessionStream.After the
StreamingSessionStreamchanges to theREADYstate, the url property will contain a stream to be used with the DCV streaming client. -
20200801.getStudioGet a studio resource.
-
20200801.getStudioComponentGets a studio component resource.
-
20200801.getStudioMemberGet a user's membership in a studio.
-
20200801.listEulaAcceptancesList EULA acceptances.
-
20200801.listEulasList EULAs.
-
20200801.listLaunchProfileMembersGet all users in a given launch profile membership.
-
20200801.listLaunchProfilesList all the launch profiles a studio.
-
20200801.listStreamingImagesList 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.
-
20200801.listStreamingSessionBackupsLists the backups of a streaming session in a studio.
-
20200801.listStreamingSessionsLists the streaming sessions in a studio.
-
20200801.listStudioComponentsLists the
StudioComponentsin a studio. -
20200801.listStudioMembersGet all users in a given studio membership.
ListStudioMembersonly returns admin members. -
20200801.listStudiosList studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
-
20200801.listTagsForResourceGets 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.
-
20200801.putLaunchProfileMembersAdd/update users with given persona to launch profile membership.
-
20200801.putStudioMembersAdd/update users with given persona to studio membership.
-
20200801.startStreamingSessionTransitions sessions from the
STOPPEDstate into theREADYstate. TheSTART_IN_PROGRESSstate is the intermediate state between theSTOPPEDandREADYstates. -
20200801.startStudioSsoConfigurationRepairRepairs 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
READYstate.After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
-
20200801.stopStreamingSessionTransitions sessions from the
READYstate into theSTOPPEDstate. TheSTOP_IN_PROGRESSstate is the intermediate state between theREADYandSTOPPEDstates. -
20200801.tagResourceCreates tags for a resource, given its ARN.
-
20200801.untagResourceDeletes the tags for a resource.
-
20200801.updateLaunchProfileUpdate a launch profile.
-
20200801.updateLaunchProfileMemberUpdate a user persona in launch profile membership.
-
20200801.updateStreamingImageUpdate streaming image.
-
20200801.updateStudioUpdate a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
-
20200801.updateStudioComponentUpdates a studio component resource.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools