Amazonka.FinSpace.Types.Environment

Documentation

data Environment

Represents an FinSpace environment.

See: newEnvironment smart constructor.

Constructors

Environment'

Fields

• awsAccountId :: Maybe Text

  The ID of the AWS account in which the FinSpace environment is created.

• dedicatedServiceAccountId :: Maybe Text

  The AWS account ID of the dedicated service account associated with your FinSpace environment.

• description :: Maybe Text

  The description of the FinSpace environment.

• environmentArn :: Maybe Text

  The Amazon Resource Name (ARN) of your FinSpace environment.

• environmentId :: Maybe Text

  The identifier of the FinSpace environment.

• environmentUrl :: Maybe Text

  The sign-in url for the web application of your FinSpace environment.

• federationMode :: Maybe FederationMode

  The authentication mode for the environment.

• federationParameters :: Maybe FederationParameters

  Configuration information when authentication mode is FEDERATED.

• kmsKeyId :: Maybe Text

  The KMS key id used to encrypt in the FinSpace environment.

• name :: Maybe Text

  The name of the FinSpace environment.

• sageMakerStudioDomainUrl :: Maybe Text

  The url of the integrated FinSpace notebook environment in your web application.

• status :: Maybe EnvironmentStatus

  The current status of creation of the FinSpace environment.

Instances

FromJSON Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

parseJSON :: Value -> Parser Environment

parseJSONList :: Value -> Parser [Environment]

Generic Environment

Defined in Amazonka.FinSpace.Types.Environment

Associated Types

type Rep Environment :: Type -> Type

Methods

from :: Environment -> Rep Environment x

to :: Rep Environment x -> Environment

Read Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

readsPrec :: Int -> ReadS Environment

readList :: ReadS [Environment]

readPrec :: ReadPrec Environment

readListPrec :: ReadPrec [Environment]

Show Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

NFData Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

rnf :: Environment -> ()

Eq Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

(==) :: Environment -> Environment -> Bool

(/=) :: Environment -> Environment -> Bool

Hashable Environment

Defined in Amazonka.FinSpace.Types.Environment

Methods

hashWithSalt :: Int -> Environment -> Int

hash :: Environment -> Int

type Rep Environment

Defined in Amazonka.FinSpace.Types.Environment

type Rep Environment = D1 ('MetaData "Environment" "Amazonka.FinSpace.Types.Environment" "amazonka-finspace-2.0-D97KpJfy3e64ziV32Jkivv" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dedicatedServiceAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "federationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationMode)) :*: (S1 ('MetaSel ('Just "federationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationParameters)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sageMakerStudioDomainUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentStatus)))))))

newEnvironment :: Environment

Create a value of Environment 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:awsAccountId:Environment', environment_awsAccountId - The ID of the AWS account in which the FinSpace environment is created.

$sel:dedicatedServiceAccountId:Environment', environment_dedicatedServiceAccountId - The AWS account ID of the dedicated service account associated with your FinSpace environment.

$sel:description:Environment', environment_description - The description of the FinSpace environment.

$sel:environmentArn:Environment', environment_environmentArn - The Amazon Resource Name (ARN) of your FinSpace environment.

$sel:environmentId:Environment', environment_environmentId - The identifier of the FinSpace environment.

$sel:environmentUrl:Environment', environment_environmentUrl - The sign-in url for the web application of your FinSpace environment.

$sel:federationMode:Environment', environment_federationMode - The authentication mode for the environment.

$sel:federationParameters:Environment', environment_federationParameters - Configuration information when authentication mode is FEDERATED.

$sel:kmsKeyId:Environment', environment_kmsKeyId - The KMS key id used to encrypt in the FinSpace environment.

$sel:name:Environment', environment_name - The name of the FinSpace environment.

$sel:sageMakerStudioDomainUrl:Environment', environment_sageMakerStudioDomainUrl - The url of the integrated FinSpace notebook environment in your web application.

$sel:status:Environment', environment_status - The current status of creation of the FinSpace environment.

environment_awsAccountId :: Lens' Environment (Maybe Text)

The ID of the AWS account in which the FinSpace environment is created.

environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text)

The AWS account ID of the dedicated service account associated with your FinSpace environment.

environment_description :: Lens' Environment (Maybe Text)

The description of the FinSpace environment.

environment_environmentArn :: Lens' Environment (Maybe Text)

The Amazon Resource Name (ARN) of your FinSpace environment.

environment_environmentId :: Lens' Environment (Maybe Text)

The identifier of the FinSpace environment.

environment_environmentUrl :: Lens' Environment (Maybe Text)

The sign-in url for the web application of your FinSpace environment.

environment_federationMode :: Lens' Environment (Maybe FederationMode)

The authentication mode for the environment.

environment_federationParameters :: Lens' Environment (Maybe FederationParameters)

Configuration information when authentication mode is FEDERATED.

environment_kmsKeyId :: Lens' Environment (Maybe Text)

The KMS key id used to encrypt in the FinSpace environment.

environment_name :: Lens' Environment (Maybe Text)

The name of the FinSpace environment.

environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text)

The url of the integrated FinSpace notebook environment in your web application.

environment_status :: Lens' Environment (Maybe EnvironmentStatus)

The current status of creation of the FinSpace environment.