AmazonNimbleStudio
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 49
- GETListEulaAcceptances
/2020-08-01/studios/:studioId/eula-acceptances?eulaIds=string&nextToken=stringList EULA acceptances. - POSTAcceptEulas
/2020-08-01/studios/:studioId/eula-acceptancesAccept EULAs. - GETListLaunchProfiles
/2020-08-01/studios/:studioId/launch-profiles?maxResults=1&nextToken=string&principalId=string&states=CREATE_IN_PROGRESSList all the launch profiles a studio. - POSTCreateLaunchProfile
/2020-08-01/studios/:studioId/launch-profilesCreate a launch profile. - GETListStreamingImages
/2020-08-01/studios/:studioId/streaming-images?nextToken=string&owner=string<p>List the streaming image resources available to this studio.</p> <p>This list will contain both images provided by Amazon Web Services, as well as… - POSTCreateStreamingImage
/2020-08-01/studios/:studioId/streaming-imagesCreates a streaming image resource in a studio. - GETListStreamingSessions
/2020-08-01/studios/:studioId/streaming-sessions?createdBy=string&nextToken=string&ownedBy=string&sessionIds=stringLists the streaming sessions in a studio. - POSTCreateStreamingSession
/2020-08-01/studios/:studioId/streaming-sessions<p>Creates a streaming session in a studio.</p> <p>After invoking this operation, you must poll GetStreamingSession until the streaming session is in the… - POSTCreateStreamingSessionStream
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId/streams<p>Creates a streaming session stream for a streaming session.</p> <p>After invoking this API, invoke GetStreamingSessionStream with the returned streamId to… - GETListStudios
/2020-08-01/studios?nextToken=stringList studios in your Amazon Web Services accounts in the requested Amazon Web Services Region. - POSTCreateStudio
/2020-08-01/studios<p>Create a new studio.</p> <p>When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users… - GETListStudioComponents
/2020-08-01/studios/:studioId/studio-components?maxResults=1&nextToken=string&states=CREATE_IN_PROGRESS&types=ACTIVE_DIRECTORYLists the <code>StudioComponents</code> in a studio. - POSTCreateStudioComponent
/2020-08-01/studios/:studioId/studio-componentsCreates a studio component resource. - GETGetLaunchProfile
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileIdGet a launch profile. - DELETEDeleteLaunchProfile
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileIdPermanently delete a launch profile. - PATCHUpdateLaunchProfile
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileIdUpdate a launch profile. - GETGetLaunchProfileMember
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/membership/:principalIdGet a user persona in launch profile membership. - DELETEDeleteLaunchProfileMember
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/membership/:principalIdDelete a user from launch profile membership. - PATCHUpdateLaunchProfileMember
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/membership/:principalIdUpdate a user persona in launch profile membership. - GETGetStreamingImage
/2020-08-01/studios/:studioId/streaming-images/:streamingImageIdGet streaming image. - DELETEDeleteStreamingImage
/2020-08-01/studios/:studioId/streaming-images/:streamingImageIdDelete streaming image. - PATCHUpdateStreamingImage
/2020-08-01/studios/:studioId/streaming-images/:streamingImageIdUpdate streaming image. - GETGetStreamingSession
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId<p>Gets StreamingSession resource.</p> <p>Invoke this operation to poll for a streaming session state while creating or deleting a session.</p> - DELETEDeleteStreamingSession
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId<p>Deletes streaming session resource.</p> <p>After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a… - GETGetStudio
/2020-08-01/studios/:studioIdGet a studio resource. - DELETEDeleteStudio
/2020-08-01/studios/:studioIdDelete a studio resource. - PATCHUpdateStudio
/2020-08-01/studios/:studioId<p>Update a Studio resource.</p> <p>Currently, this operation only supports updating the displayName of your studio.</p> - GETGetStudioComponent
/2020-08-01/studios/:studioId/studio-components/:studioComponentIdGets a studio component resource. - DELETEDeleteStudioComponent
/2020-08-01/studios/:studioId/studio-components/:studioComponentIdDeletes a studio component resource. - PATCHUpdateStudioComponent
/2020-08-01/studios/:studioId/studio-components/:studioComponentIdUpdates a studio component resource. - GETGetStudioMember
/2020-08-01/studios/:studioId/membership/:principalIdGet a user's membership in a studio. - DELETEDeleteStudioMember
/2020-08-01/studios/:studioId/membership/:principalIdDelete a user from studio membership. - GETGetEula
/2020-08-01/eulas/:eulaIdGet EULA. - GETGetLaunchProfileDetails
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/detailsLaunch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This… - GETGetLaunchProfileInitialization
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/init#launchProfileProtocolVersions&launchPurpose&platform?launchProfileProtocolVersions=string&launchPurpose=string&platform=stringGet a launch profile initialization. - GETGetStreamingSessionBackup
/2020-08-01/studios/:studioId/streaming-session-backups/:backupId<p>Gets <code>StreamingSessionBackup</code> resource.</p> <p>Invoke this operation to poll for a streaming session backup while stopping a streaming… - GETGetStreamingSessionStream
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId/streams/:streamId<p>Gets a StreamingSessionStream for a streaming session.</p> <p>Invoke this operation to poll the resource after invoking… - GETListEulas
/2020-08-01/eulas?eulaIds=string&nextToken=stringList EULAs. - GETListLaunchProfileMembers
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/membership?maxResults=1&nextToken=stringGet all users in a given launch profile membership. - POSTPutLaunchProfileMembers
/2020-08-01/studios/:studioId/launch-profiles/:launchProfileId/membershipAdd/update users with given persona to launch profile membership. - GETListStreamingSessionBackups
/2020-08-01/studios/:studioId/streaming-session-backups?nextToken=string&ownedBy=stringLists the backups of a streaming session in a studio. - GETListStudioMembers
/2020-08-01/studios/:studioId/membership?maxResults=1&nextToken=string<p>Get all users in a given studio membership.</p> <note> <p> <code>ListStudioMembers</code> only returns admin members.</p> </note> - POSTPutStudioMembers
/2020-08-01/studios/:studioId/membershipAdd/update users with given persona to studio membership. - GETListTagsForResource
/2020-08-01/tags/:resourceArn<p>Gets the tags for a resource, given its Amazon Resource Names (ARN).</p> <p>This operation supports ARNs for all resource types in Nimble Studio that… - POSTTagResource
/2020-08-01/tags/:resourceArnCreates tags for a resource, given its ARN. - POSTStartStreamingSession
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId/startTransitions sessions from the <code>STOPPED</code> state into the <code>READY</code> state. The <code>START_IN_PROGRESS</code> state is the intermediate state… - PUTStartStudioSSOConfigurationRepair
/2020-08-01/studios/:studioId/sso-configuration<p>Repairs the IAM Identity Center configuration for a given studio.</p> <p>If the studio has a valid IAM Identity Center configuration currently associated… - POSTStopStreamingSession
/2020-08-01/studios/:studioId/streaming-sessions/:sessionId/stopTransitions sessions from the <code>READY</code> state into the <code>STOPPED</code> state. The <code>STOP_IN_PROGRESS</code> state is the intermediate state… - DELETEUntagResource
/2020-08-01/tags/:resourceArn#tagKeys?tagKeys=stringDeletes the tags for a resource.
API details
- Base URL
http://nimble.{region}.amazonaws.comhttps://nimble.{region}.amazonaws.comhttp://nimble.{region}.amazonaws.com.cnhttps://nimble.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 49 operations on 28 pathsGET 23POST 12DELETE 8PATCH 5PUT 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2020-08-01 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the AmazonNimbleStudio in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonNimbleStudio collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ListEulaAcceptances” (GET /2020-08-01/studios/:studioId/eula-acceptances?eulaIds=string&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AmazonNimbleStudio?
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… It is listed under Developer tools and has 49 endpoints.
Who publishes the AmazonNimbleStudio?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AmazonNimbleStudio?
Its description lists 4 base URLs: http://nimble.{region}.amazonaws.com, https://nimble.{region}.amazonaws.com, http://nimble.{region}.amazonaws.com.cn, https://nimble.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the AmazonNimbleStudio?
With an API key in the Authorization header.
How many endpoints does the AmazonNimbleStudio have?
49 operations on 28 paths (23 GET, 12 POST, 8 DELETE, 5 PATCH, 1 PUT).
Is forking the AmazonNimbleStudio free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.