finspace / Client / create_environment

create_environment#

finspace.Client.create_environment(**kwargs)#

Create a new FinSpace environment.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_environment(
    name='string',
    description='string',
    kmsKeyId='string',
    tags={
        'string': 'string'
    },
    federationMode='FEDERATED'|'LOCAL',
    federationParameters={
        'samlMetadataDocument': 'string',
        'samlMetadataURL': 'string',
        'applicationCallBackURL': 'string',
        'federationURN': 'string',
        'federationProviderName': 'string',
        'attributeMap': {
            'string': 'string'
        }
    },
    superuserParameters={
        'emailAddress': 'string',
        'firstName': 'string',
        'lastName': 'string'
    },
    dataBundles=[
        'string',
    ]
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the FinSpace environment to be created.

  • description (string) – The description of the FinSpace environment to be created.

  • kmsKeyId (string) – The KMS key id to encrypt your data in the FinSpace environment.

  • tags (dict) –

    Add tags to your FinSpace environment.

    • (string) –

      • (string) –

  • federationMode (string) –

    Authentication mode for the environment.

    • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

    • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

  • federationParameters (dict) –

    Configuration information when authentication mode is FEDERATED.

    • samlMetadataDocument (string) –

      SAML 2.0 Metadata document from identity provider (IdP).

    • samlMetadataURL (string) –

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

    • applicationCallBackURL (string) –

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

    • federationURN (string) –

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

    • federationProviderName (string) –

      Name of the identity provider (IdP).

    • attributeMap (dict) –

      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.

      • (string) –

        • (string) –

  • superuserParameters (dict) –

    Configuration information for the superuser.

    • emailAddress (string) – [REQUIRED]

      The email address of the superuser.

    • firstName (string) – [REQUIRED]

      The first name of the superuser.

    • lastName (string) – [REQUIRED]

      The last name of the superuser.

  • dataBundles (list) –

    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

    • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

    • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

    • (string) –

      The Amazon Resource Name (ARN) of the data bundle.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string',
    'environmentArn': 'string',
    'environmentUrl': 'string'
}

Response Structure

  • (dict) –

    • environmentId (string) –

      The unique identifier for FinSpace environment that you created.

    • environmentArn (string) –

      The Amazon Resource Name (ARN) of the FinSpace environment that you created.

    • environmentUrl (string) –

      The sign-in URL for the web application of the FinSpace environment you created.

Exceptions