:doc:`finspace <../../finspace>` / Client / create_environment

******************
create_environment
******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment>`_  


  **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',
        ]
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the FinSpace environment to be created.

    

  
  :type description: string
  :param description: 

    The description of the FinSpace environment to be created.

    

  
  :type kmsKeyId: string
  :param kmsKeyId: 

    The KMS key id to encrypt your data in the FinSpace environment.

    

  
  :type tags: dict
  :param tags: 

    Add tags to your FinSpace environment.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type federationMode: string
  :param federationMode: 

    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.
    

    

  
  :type federationParameters: dict
  :param federationParameters: 

    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) --* 

        
  

  
  :type superuserParameters: dict
  :param superuserParameters: 

    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.

      

    
  
  :type dataBundles: list
  :param dataBundles: 

    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.

      

    

  
  :rtype: 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**
  
  *   :py:class:`finspace.Client.exceptions.InternalServerException`

  
  *   :py:class:`finspace.Client.exceptions.ValidationException`

  
  *   :py:class:`finspace.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`finspace.Client.exceptions.ThrottlingException`

  
  *   :py:class:`finspace.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`finspace.Client.exceptions.LimitExceededException`

  