:doc:`DataZone <../../datazone>` / Client / create_domain

*************
create_domain
*************



.. py:method:: DataZone.Client.create_domain(**kwargs)

  

  Creates an Amazon DataZone domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateDomain>`_  


  **Request Syntax**
  ::

    response = client.create_domain(
        name='string',
        description='string',
        singleSignOn={
            'type': 'IAM_IDC'|'DISABLED',
            'userAssignment': 'AUTOMATIC'|'MANUAL',
            'idcInstanceArn': 'string'
        },
        domainExecutionRole='string',
        kmsKeyIdentifier='string',
        tags={
            'string': 'string'
        },
        domainVersion='V1'|'V2',
        serviceRole='string',
        clientToken='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the Amazon DataZone domain.

    

  
  :type description: string
  :param description: 

    The description of the Amazon DataZone domain.

    

  
  :type singleSignOn: dict
  :param singleSignOn: 

    The single-sign on configuration of the Amazon DataZone domain.

    

  
    - **type** *(string) --* 

      The type of single sign-on in Amazon DataZone.

      

    
    - **userAssignment** *(string) --* 

      The single sign-on user assignment in Amazon DataZone.

      

    
    - **idcInstanceArn** *(string) --* 

      The ARN of the IDC instance.

      

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

    The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

    

  
  :type kmsKeyIdentifier: string
  :param kmsKeyIdentifier: 

    The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

    

  
  :type tags: dict
  :param tags: 

    The tags specified for the Amazon DataZone domain.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type domainVersion: string
  :param domainVersion: 

    The version of the domain that is created.

    

  
  :type serviceRole: string
  :param serviceRole: 

    The service role of the domain that is created.

    

  
  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'id': 'string',
          'rootDomainUnitId': 'string',
          'name': 'string',
          'description': 'string',
          'singleSignOn': {
              'type': 'IAM_IDC'|'DISABLED',
              'userAssignment': 'AUTOMATIC'|'MANUAL',
              'idcInstanceArn': 'string'
          },
          'domainExecutionRole': 'string',
          'arn': 'string',
          'kmsKeyIdentifier': 'string',
          'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
          'portalUrl': 'string',
          'tags': {
              'string': 'string'
          },
          'domainVersion': 'V1'|'V2',
          'serviceRole': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The identifier of the Amazon DataZone domain.

        
      

      - **rootDomainUnitId** *(string) --* 

        The ID of the root domain unit.

        
      

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

        The name of the Amazon DataZone domain.

        
      

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

        The description of the Amazon DataZone domain.

        
      

      - **singleSignOn** *(dict) --* 

        The single-sign on configuration of the Amazon DataZone domain.

        
        

        - **type** *(string) --* 

          The type of single sign-on in Amazon DataZone.

          
        

        - **userAssignment** *(string) --* 

          The single sign-on user assignment in Amazon DataZone.

          
        

        - **idcInstanceArn** *(string) --* 

          The ARN of the IDC instance.

          
    
      

      - **domainExecutionRole** *(string) --* 

        The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

        
      

      - **arn** *(string) --* 

        The ARN of the Amazon DataZone domain.

        
      

      - **kmsKeyIdentifier** *(string) --* 

        The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

        
      

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

        The status of the Amazon DataZone domain.

        
      

      - **portalUrl** *(string) --* 

        The URL of the data portal for this Amazon DataZone domain.

        
      

      - **tags** *(dict) --* 

        The tags specified for the Amazon DataZone domain.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **domainVersion** *(string) --* 

        The version of the domain that is created.

        
      

      - **serviceRole** *(string) --* 

        Te service role of the domain that is created.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

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

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

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

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

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

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  