Studio - Amazon Nimble Studio

Studio

Represents a studio resource.

A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.

When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via AWS SSO and your identity source.

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.

Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.

URI

/2020-08-01/studios/studioId

HTTP methods

GET

Operation ID: GetStudio

Get a Studio resource.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Responses
Status code Response model Description
200 GetStudioOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

DELETE

Operation ID: DeleteStudio

Delete a studio resource.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 DeleteStudioOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

PATCH

Operation ID: UpdateStudio

Update a Studio resource.

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

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 UpdateStudioOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

Schemas

Request bodies

{ "displayName": "string", "userRoleArn": "string", "adminRoleArn": "string" }
{ "displayName": "string", "userRoleArn": "string", "adminRoleArn": "string" }

Response bodies

{ "studio": { "displayName": "string", "userRoleArn": "string", "adminRoleArn": "string", "studioName": "string", "studioEncryptionConfiguration": { "keyArn": "string", "keyType": enum }, "createdAt": "string", "updatedAt": "string", "studioId": "string", "state": enum, "statusCode": enum, "statusMessage": "string", "ssoClientId": "string", "studioUrl": "string", "homeRegion": "string", "arn": "string", "tags": { } } }
{ "studio": { "displayName": "string", "userRoleArn": "string", "adminRoleArn": "string", "studioName": "string", "studioEncryptionConfiguration": { "keyArn": "string", "keyType": enum }, "createdAt": "string", "updatedAt": "string", "studioId": "string", "state": enum, "statusCode": enum, "statusMessage": "string", "ssoClientId": "string", "studioUrl": "string", "homeRegion": "string", "arn": "string", "tags": { } } }
{ "studio": { "displayName": "string", "userRoleArn": "string", "adminRoleArn": "string", "studioName": "string", "studioEncryptionConfiguration": { "keyArn": "string", "keyType": enum }, "createdAt": "string", "updatedAt": "string", "studioId": "string", "state": enum, "statusCode": enum, "statusMessage": "string", "ssoClientId": "string", "studioUrl": "string", "homeRegion": "string", "arn": "string", "tags": { } } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }

Properties

AccessDeniedException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ConflictException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

DeleteStudioOutput

Property Type Required Description
studio

Studio

False

Information about a studio.

ExceptionContext

ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.

ExceptionContext enables scripts and other programmatic clients to provide for better error handling.

Property Type Required Description

*

string

False

GetStudioOutput

Property Type Required Description
studio

Studio

False

Information about a studio.

InternalServerException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ResourceNotFoundException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ServiceQuotaExceededException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

Studio

Property Type Required Description
displayName

string

False

A friendly name for the studio.

userRoleArn

string

False

The IAM role that studio users assume when logging in to the Nimble Studio portal.

adminRoleArn

string

False

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

studioName

string

False

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

studioEncryptionConfiguration

StudioEncryptionConfiguration

False

Configuration of the encryption method that is used for the studio.

createdAt

string

False

The Unix epoch timestamp in seconds for when the resource was created.

updatedAt

string

False

The Unix epoch timestamp in seconds for when the resource was updated.

studioId

string

False

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

state

StudioState

False

The current state of the studio resource.

statusCode

StudioStatusCode

False

Status codes that provide additional detail on the studio state.

statusMessage

string

False

Additional detail on the studio state.

ssoClientId

string

False

The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

studioUrl

string

False

The address of the web page for the studio.

homeRegion

string

False

The AWS Region where the studio resource is located.

arn

string

False

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

tags

Tags

False

A collection of labels, in the form of key:value pairs, that apply to this resource.

StudioEncryptionConfiguration

Configuration of the encryption method that is used for the studio.

Property Type Required Description
keyArn

string

False

The ARN for a KMS key that is used to encrypt studio data.

keyType

StudioEncryptionConfigurationKeyType

True

The type of KMS key that is used to encrypt studio data.

StudioEncryptionConfigurationKeyType

The type of KMS key that is used to encrypt studio data.

  • AWS_OWNED_KEY

  • CUSTOMER_MANAGED_KEY

StudioState

  • CREATE_IN_PROGRESS

  • READY

  • UPDATE_IN_PROGRESS

  • DELETE_IN_PROGRESS

  • DELETED

  • DELETE_FAILED

  • CREATE_FAILED

  • UPDATE_FAILED

StudioStatusCode

The status code.

  • STUDIO_CREATED

  • STUDIO_DELETED

  • STUDIO_UPDATED

  • STUDIO_CREATE_IN_PROGRESS

  • STUDIO_UPDATE_IN_PROGRESS

  • STUDIO_DELETE_IN_PROGRESS

  • STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED

  • STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED

  • STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED

  • AWS_SSO_NOT_ENABLED

  • AWS_SSO_ACCESS_DENIED

  • ROLE_NOT_OWNED_BY_STUDIO_OWNER

  • ROLE_COULD_NOT_BE_ASSUMED

  • INTERNAL_ERROR

  • ENCRYPTION_KEY_NOT_FOUND

  • ENCRYPTION_KEY_ACCESS_DENIED

  • AWS_SSO_CONFIGURATION_REPAIRED

  • AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS

Tags

Property Type Required Description

*

string

False

ThrottlingException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

UpdateStudioInput

Property Type Required Description
displayName

string

False

A friendly name for the studio.

userRoleArn

string

False

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

adminRoleArn

string

False

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

UpdateStudioOutput

Property Type Required Description
studio

Studio

False

Information about a studio.

ValidationException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetStudio

DeleteStudio

UpdateStudio