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

***************
get_environment
***************



.. py:method:: finspace.Client.get_environment(**kwargs)

  

  Returns the FinSpace environment object.

  

  .. 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/GetEnvironment>`_  


  **Request Syntax**
  ::

    response = client.get_environment(
        environmentId='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    The identifier of the FinSpace environment.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'environment': {
              'name': 'string',
              'environmentId': 'string',
              'awsAccountId': 'string',
              'status': 'CREATE_REQUESTED'|'CREATING'|'CREATED'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'FAILED_CREATION'|'RETRY_DELETION'|'FAILED_DELETION'|'UPDATE_NETWORK_REQUESTED'|'UPDATING_NETWORK'|'FAILED_UPDATING_NETWORK'|'SUSPENDED',
              'environmentUrl': 'string',
              'description': 'string',
              'environmentArn': 'string',
              'sageMakerStudioDomainUrl': 'string',
              'kmsKeyId': 'string',
              'dedicatedServiceAccountId': 'string',
              'federationMode': 'FEDERATED'|'LOCAL',
              'federationParameters': {
                  'samlMetadataDocument': 'string',
                  'samlMetadataURL': 'string',
                  'applicationCallBackURL': 'string',
                  'federationURN': 'string',
                  'federationProviderName': 'string',
                  'attributeMap': {
                      'string': 'string'
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **environment** *(dict) --* 

        The name of the FinSpace environment.

        
        

        - **name** *(string) --* 

          The name of the FinSpace environment.

          
        

        - **environmentId** *(string) --* 

          The identifier of the FinSpace environment.

          
        

        - **awsAccountId** *(string) --* 

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

          
        

        - **status** *(string) --* 

          The current status of creation of the FinSpace environment.

          
        

        - **environmentUrl** *(string) --* 

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

          
        

        - **description** *(string) --* 

          The description of the FinSpace environment.

          
        

        - **environmentArn** *(string) --* 

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

          
        

        - **sageMakerStudioDomainUrl** *(string) --* 

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

          
        

        - **kmsKeyId** *(string) --* 

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

          
        

        - **dedicatedServiceAccountId** *(string) --* 

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

          
        

        - **federationMode** *(string) --* 

          The authentication mode for the 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) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`finspace.Client.exceptions.ResourceNotFoundException`

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

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

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

  