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 IAM Identity Center 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.
Contents
- adminRoleArn
-
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- arn
-
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
Type: String
Required: No
- createdAt
-
The ISO timestamp in seconds for when the resource was created.
Type: Timestamp
Required: No
- displayName
-
A friendly name for the studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
- homeRegion
-
The AWS Region where the studio resource is located.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]
Required: No
- ssoClientId
-
The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
Type: String
Required: No
- state
-
The current state of the studio resource.
Type: String
Valid Values:
CREATE_IN_PROGRESS | READY | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | DELETED | DELETE_FAILED | CREATE_FAILED | UPDATE_FAILED
Required: No
- statusCode
-
Status codes that provide additional detail on the studio state.
Type: String
Valid Values:
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 | AWS_STS_REGION_DISABLED
Required: No
- statusMessage
-
Additional detail on the studio state.
Type: String
Required: No
- studioEncryptionConfiguration
-
Configuration of the encryption method that is used for the studio.
Type: StudioEncryptionConfiguration object
Required: No
- studioId
-
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
Type: String
Required: No
- studioName
-
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-z0-9]*$
Required: No
- studioUrl
-
The address of the web page for the studio.
Type: String
Required: No
-
A collection of labels, in the form of key-value pairs, that apply to this resource.
Type: String to string map
Required: No
- updatedAt
-
The ISO timestamp in seconds for when the resource was updated.
Type: Timestamp
Required: No
- userRoleArn
-
The IAM role that studio users assume when logging in to the Nimble Studio portal.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: