libZSservicesZSamazonka-finspaceZSamazonka-finspace
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.FinSpace.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2021-03-12 of the Amazon FinSpace User Environment Management service SDK configuration.

Errors

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The input fails to satisfy the constraints specified by an AWS service.

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You do not have sufficient access to perform this action.

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request is invalid. Something is wrong with the input to the request.

_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was denied due to request throttling.

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request processing has failed because of an unknown error, exception or failure.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more resources can't be found.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A service limit or quota is exceeded.

EnvironmentStatus

newtype EnvironmentStatus Source #

Instances

Instances details
Eq EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Ord EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Read EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Show EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Generic EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Associated Types

type Rep EnvironmentStatus :: Type -> Type #

NFData EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

Methods

rnf :: EnvironmentStatus -> () #

Hashable EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToJSON EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToJSONKey EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

FromJSON EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

FromJSONKey EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToLog EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToHeader EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToQuery EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

FromXML EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToXML EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToByteString EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

FromText EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

ToText EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

type Rep EnvironmentStatus Source # 
Instance details

Defined in Amazonka.FinSpace.Types.EnvironmentStatus

type Rep EnvironmentStatus = D1 ('MetaData "EnvironmentStatus" "Amazonka.FinSpace.Types.EnvironmentStatus" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'True) (C1 ('MetaCons "EnvironmentStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEnvironmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FederationMode

newtype FederationMode Source #

Constructors

FederationMode' 

Instances

Instances details
Eq FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Ord FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Read FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Show FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Generic FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Associated Types

type Rep FederationMode :: Type -> Type #

NFData FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Methods

rnf :: FederationMode -> () #

Hashable FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToJSON FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToJSONKey FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

FromJSON FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

FromJSONKey FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToLog FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToHeader FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToQuery FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

FromXML FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToXML FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

Methods

toXML :: FederationMode -> XML #

ToByteString FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

FromText FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

ToText FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

type Rep FederationMode Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationMode

type Rep FederationMode = D1 ('MetaData "FederationMode" "Amazonka.FinSpace.Types.FederationMode" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'True) (C1 ('MetaCons "FederationMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFederationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Environment

data Environment Source #

Represents an FinSpace environment.

See: newEnvironment smart constructor.

Constructors

Environment' 

Fields

Instances

Instances details
Eq Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

Read Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

Show Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

Generic Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

Associated Types

type Rep Environment :: Type -> Type #

NFData Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

Methods

rnf :: Environment -> () #

Hashable Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

FromJSON Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

type Rep Environment Source # 
Instance details

Defined in Amazonka.FinSpace.Types.Environment

type Rep Environment = D1 ('MetaData "Environment" "Amazonka.FinSpace.Types.Environment" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentStatus)) :*: (S1 ('MetaSel ('Just "federationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationParameters)) :*: S1 ('MetaSel ('Just "dedicatedServiceAccountId") '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 "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sageMakerStudioDomainUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEnvironment :: Environment Source #

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:status:Environment', environment_status - The current status of creation of the FinSpace environment.

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

$sel:dedicatedServiceAccountId:Environment', environment_dedicatedServiceAccountId - The AWS account ID of the dedicated service account associated with your 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:awsAccountId:Environment', environment_awsAccountId - The ID of the AWS account in which the FinSpace environment is created.

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

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

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

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

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

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

environment_status :: Lens' Environment (Maybe EnvironmentStatus) Source #

The current status of creation of the FinSpace environment.

environment_federationParameters :: Lens' Environment (Maybe FederationParameters) Source #

Configuration information when authentication mode is FEDERATED.

environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text) Source #

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

environment_environmentUrl :: Lens' Environment (Maybe Text) Source #

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

environment_federationMode :: Lens' Environment (Maybe FederationMode) Source #

The authentication mode for the environment.

environment_awsAccountId :: Lens' Environment (Maybe Text) Source #

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

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the FinSpace environment.

environment_kmsKeyId :: Lens' Environment (Maybe Text) Source #

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

environment_environmentId :: Lens' Environment (Maybe Text) Source #

The identifier of the FinSpace environment.

environment_environmentArn :: Lens' Environment (Maybe Text) Source #

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

environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text) Source #

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

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the FinSpace environment.

FederationParameters

data FederationParameters Source #

Configuration information when authentication mode is FEDERATED.

See: newFederationParameters smart constructor.

Constructors

FederationParameters' 

Fields

  • samlMetadataURL :: Maybe Text

    Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

  • applicationCallBackURL :: Maybe Text

    The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

  • federationURN :: Maybe Text

    The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

  • attributeMap :: Maybe (HashMap Text Text)

    SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

  • federationProviderName :: Maybe Text

    Name of the identity provider (IdP).

  • samlMetadataDocument :: Maybe Text

    SAML 2.0 Metadata document from identity provider (IdP).

Instances

Instances details
Eq FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

Read FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

Show FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

Generic FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

Associated Types

type Rep FederationParameters :: Type -> Type #

NFData FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

Methods

rnf :: FederationParameters -> () #

Hashable FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

ToJSON FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

FromJSON FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

type Rep FederationParameters Source # 
Instance details

Defined in Amazonka.FinSpace.Types.FederationParameters

type Rep FederationParameters = D1 ('MetaData "FederationParameters" "Amazonka.FinSpace.Types.FederationParameters" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'False) (C1 ('MetaCons "FederationParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "samlMetadataURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "applicationCallBackURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "federationURN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "attributeMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "federationProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "samlMetadataDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newFederationParameters :: FederationParameters Source #

Create a value of FederationParameters 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:samlMetadataURL:FederationParameters', federationParameters_samlMetadataURL - Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

$sel:applicationCallBackURL:FederationParameters', federationParameters_applicationCallBackURL - The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

$sel:federationURN:FederationParameters', federationParameters_federationURN - The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

$sel:attributeMap:FederationParameters', federationParameters_attributeMap - SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

$sel:federationProviderName:FederationParameters', federationParameters_federationProviderName - Name of the identity provider (IdP).

$sel:samlMetadataDocument:FederationParameters', federationParameters_samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).

federationParameters_samlMetadataURL :: Lens' FederationParameters (Maybe Text) Source #

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

federationParameters_applicationCallBackURL :: Lens' FederationParameters (Maybe Text) Source #

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

federationParameters_federationURN :: Lens' FederationParameters (Maybe Text) Source #

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

federationParameters_attributeMap :: Lens' FederationParameters (Maybe (HashMap Text Text)) Source #

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

federationParameters_samlMetadataDocument :: Lens' FederationParameters (Maybe Text) Source #

SAML 2.0 Metadata document from identity provider (IdP).