Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Nimble.Types.Studio

Description

Synopsis

data Studio = Studio' {
- adminRoleArn :: Maybe Text
- arn :: Maybe Text
- createdAt :: Maybe ISO8601
- displayName :: Maybe (Sensitive Text)
- homeRegion :: Maybe Text
- ssoClientId :: Maybe Text
- state :: Maybe StudioState
- statusCode :: Maybe StudioStatusCode
- statusMessage :: Maybe Text
- studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
- studioId :: Maybe Text
- studioName :: Maybe Text
- studioUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- updatedAt :: Maybe ISO8601
- userRoleArn :: Maybe Text
}
newStudio :: Studio
studio_adminRoleArn :: Lens' Studio (Maybe Text)
studio_arn :: Lens' Studio (Maybe Text)
studio_createdAt :: Lens' Studio (Maybe UTCTime)
studio_displayName :: Lens' Studio (Maybe Text)
studio_homeRegion :: Lens' Studio (Maybe Text)
studio_ssoClientId :: Lens' Studio (Maybe Text)
studio_state :: Lens' Studio (Maybe StudioState)
studio_statusCode :: Lens' Studio (Maybe StudioStatusCode)
studio_statusMessage :: Lens' Studio (Maybe Text)
studio_studioEncryptionConfiguration :: Lens' Studio (Maybe StudioEncryptionConfiguration)
studio_studioId :: Lens' Studio (Maybe Text)
studio_studioName :: Lens' Studio (Maybe Text)
studio_studioUrl :: Lens' Studio (Maybe Text)
studio_tags :: Lens' Studio (Maybe (HashMap Text Text))
studio_updatedAt :: Lens' Studio (Maybe UTCTime)
studio_userRoleArn :: Lens' Studio (Maybe Text)

Documentation

data Studio Source #

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.

See: newStudio smart constructor.

Constructors

Studio'

Fields

adminRoleArn :: Maybe Text
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
arn :: Maybe Text
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
createdAt :: Maybe ISO8601
The ISO timestamp in seconds for when the resource was created.
displayName :: Maybe (Sensitive Text)
A friendly name for the studio.
homeRegion :: Maybe Text
The Amazon Web Services Region where the studio resource is located.
ssoClientId :: Maybe Text
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.
state :: Maybe StudioState
The current state of the studio resource.
statusCode :: Maybe StudioStatusCode
Status codes that provide additional detail on the studio state.
statusMessage :: Maybe Text
Additional detail on the studio state.
studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
Configuration of the encryption method that is used for the studio.
studioId :: Maybe Text
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
studioName :: Maybe Text
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
studioUrl :: Maybe Text
The address of the web page for the studio.
tags :: Maybe (HashMap Text Text)
A collection of labels, in the form of key-value pairs, that apply to this resource.
updatedAt :: Maybe ISO8601
The ISO timestamp in seconds for when the resource was updated.
userRoleArn :: Maybe Text
The IAM role that studio users assume when logging in to the Nimble Studio portal.

Instances

Instances details

FromJSON Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Methods parseJSON :: Value -> Parser Studio # parseJSONList :: Value -> Parser [Studio] #
Generic Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Associated Types type Rep Studio :: Type -> Type # Methods from :: Studio -> Rep Studio x # to :: Rep Studio x -> Studio #
Show Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Methods showsPrec :: Int -> Studio -> ShowS # show :: Studio -> String # showList :: [Studio] -> ShowS #
NFData Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Methods rnf :: Studio -> () #
Eq Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Methods (==) :: Studio -> Studio -> Bool # (/=) :: Studio -> Studio -> Bool #
Hashable Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio Methods hashWithSalt :: Int -> Studio -> Int # hash :: Studio -> Int #
type Rep Studio Source #
Instance details Defined in Amazonka.Nimble.Types.Studio type Rep Studio = D1 ('MetaData "Studio" "Amazonka.Nimble.Types.Studio" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "Studio'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "adminRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "homeRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ssoClientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioState)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioStatusCode))))) :: (((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "studioEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioEncryptionConfiguration))) :: (S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "studioName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "studioUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "userRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newStudio :: Studio Source #

Create a value of Studio with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:adminRoleArn:Studio', studio_adminRoleArn - The IAM role that studio admins assume when logging in to the Nimble Studio portal.

$sel:arn:Studio', studio_arn - The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

$sel:createdAt:Studio', studio_createdAt - The ISO timestamp in seconds for when the resource was created.

$sel:displayName:Studio', studio_displayName - A friendly name for the studio.

$sel:homeRegion:Studio', studio_homeRegion - The Amazon Web Services Region where the studio resource is located.

$sel:ssoClientId:Studio', studio_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.

$sel:state:Studio', studio_state - The current state of the studio resource.

$sel:statusCode:Studio', studio_statusCode - Status codes that provide additional detail on the studio state.

$sel:statusMessage:Studio', studio_statusMessage - Additional detail on the studio state.

$sel:studioEncryptionConfiguration:Studio', studio_studioEncryptionConfiguration - Configuration of the encryption method that is used for the studio.

$sel:studioId:Studio', studio_studioId - The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

$sel:studioName:Studio', studio_studioName - The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

$sel:studioUrl:Studio', studio_studioUrl - The address of the web page for the studio.

$sel:tags:Studio', studio_tags - A collection of labels, in the form of key-value pairs, that apply to this resource.

$sel:updatedAt:Studio', studio_updatedAt - The ISO timestamp in seconds for when the resource was updated.

$sel:userRoleArn:Studio', studio_userRoleArn - The IAM role that studio users assume when logging in to the Nimble Studio portal.

studio_adminRoleArn :: Lens' Studio (Maybe Text) Source #

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

studio_arn :: Lens' Studio (Maybe Text) Source #

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

studio_createdAt :: Lens' Studio (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was created.

studio_displayName :: Lens' Studio (Maybe Text) Source #

A friendly name for the studio.

studio_homeRegion :: Lens' Studio (Maybe Text) Source #

The Amazon Web Services Region where the studio resource is located.

studio_ssoClientId :: Lens' Studio (Maybe Text) Source #

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.

studio_state :: Lens' Studio (Maybe StudioState) Source #

The current state of the studio resource.

studio_statusCode :: Lens' Studio (Maybe StudioStatusCode) Source #

Status codes that provide additional detail on the studio state.

studio_statusMessage :: Lens' Studio (Maybe Text) Source #

Additional detail on the studio state.

studio_studioEncryptionConfiguration :: Lens' Studio (Maybe StudioEncryptionConfiguration) Source #

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

studio_studioId :: Lens' Studio (Maybe Text) Source #

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

studio_studioName :: Lens' Studio (Maybe Text) Source #

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

studio_studioUrl :: Lens' Studio (Maybe Text) Source #

The address of the web page for the studio.

studio_tags :: Lens' Studio (Maybe (HashMap Text Text)) Source #

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

studio_updatedAt :: Lens' Studio (Maybe UTCTime) Source #

The ISO timestamp in seconds for when the resource was updated.

studio_userRoleArn :: Lens' Studio (Maybe Text) Source #

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