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

*************
update_domain
*************



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

  

  Updates a Amazon DataZone domain.

  

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


  **Request Syntax**
  ::

    response = client.update_domain(
        identifier='string',
        description='string',
        singleSignOn={
            'type': 'IAM_IDC'|'DISABLED',
            'userAssignment': 'AUTOMATIC'|'MANUAL',
            'idcInstanceArn': 'string'
        },
        domainExecutionRole='string',
        serviceRole='string',
        name='string',
        clientToken='string'
    )
    
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The ID of the Amazon Web Services domain that is to be updated.

    

  
  :type description: string
  :param description: 

    The description to be updated as part of the ``UpdateDomain`` action.

    

  
  :type singleSignOn: dict
  :param singleSignOn: 

    The single sign-on option to be updated as part of the ``UpdateDomain`` action.

    

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

    The domain execution role to be updated as part of the ``UpdateDomain`` action.

    

  
  :type serviceRole: string
  :param serviceRole: 

    The service role of the domain.

    

  
  :type name: string
  :param name: 

    The name to be updated as part of the ``UpdateDomain`` action.

    

  
  :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',
          'description': 'string',
          'singleSignOn': {
              'type': 'IAM_IDC'|'DISABLED',
              'userAssignment': 'AUTOMATIC'|'MANUAL',
              'idcInstanceArn': 'string'
          },
          'domainExecutionRole': 'string',
          'serviceRole': 'string',
          'name': 'string',
          'lastUpdatedAt': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The identifier of the Amazon DataZone domain.

        
      

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

        The ID of the root domain unit.

        
      

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

        The description to be updated as part of the ``UpdateDomain`` action.

        
      

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

        The single sign-on option 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 to be updated as part of the ``UpdateDomain`` action.

        
      

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

        The service role of the domain.

        
      

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

        The name to be updated as part of the ``UpdateDomain`` action.

        
      

      - **lastUpdatedAt** *(datetime) --* 

        Specifies the timestamp of when the domain was last updated.

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

  