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

*********************
create_kx_environment
*********************



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

  

  Creates a managed kdb environment for the account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironment>`_  


  **Request Syntax**
  ::

    response = client.create_kx_environment(
        name='string',
        description='string',
        kmsKeyId='string',
        tags={
            'string': 'string'
        },
        clientToken='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the kdb environment that you want to create.

    

  
  :type description: string
  :param description: 

    A description for the kdb environment.

    

  
  :type kmsKeyId: string
  :param kmsKeyId: **[REQUIRED]** 

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

    

  
  :type tags: dict
  :param tags: 

    A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type clientToken: string
  :param clientToken: 

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'name': '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',
          'environmentId': 'string',
          'description': 'string',
          'environmentArn': 'string',
          'kmsKeyId': 'string',
          'creationTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The name of the kdb environment.

        
      

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

        The status of the kdb environment.

        
      

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

        A unique identifier for the kdb environment.

        
      

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

        A description for the kdb environment.

        
      

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

        The ARN identifier of the environment.

        
      

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

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

        
      

      - **creationTimestamp** *(datetime) --* 

        The timestamp at which the kdb environment was created in FinSpace.

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

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

  