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

**************************
update_environment_profile
**************************



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

  

  Updates the specified environment profile in Amazon DataZone.

  

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


  **Request Syntax**
  ::

    response = client.update_environment_profile(
        domainIdentifier='string',
        identifier='string',
        name='string',
        description='string',
        userParameters=[
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        awsAccountId='string',
        awsAccountRegion='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

    

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

    The identifier of the environment profile that is to be updated.

    

  
  :type name: string
  :param name: 

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

    

  
  :type description: string
  :param description: 

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

    

  
  :type userParameters: list
  :param userParameters: 

    The user parameters to be updated as part of the ``UpdateEnvironmentProfile`` action.

    

  
    - *(dict) --* 

      The parameter details of an evironment profile.

      

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

        The name of an environment profile parameter.

        

      
      - **value** *(string) --* 

        The value of an environment profile parameter.

        

      
    

  :type awsAccountId: string
  :param awsAccountId: 

    The Amazon Web Services account in which a specified environment profile is to be udpated.

    

  
  :type awsAccountRegion: string
  :param awsAccountRegion: 

    The Amazon Web Services Region in which a specified environment profile is to be updated.

    

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

    
    ::

      {
          'id': 'string',
          'domainId': 'string',
          'awsAccountId': 'string',
          'awsAccountRegion': 'string',
          'createdBy': 'string',
          'createdAt': datetime(2015, 1, 1),
          'updatedAt': datetime(2015, 1, 1),
          'name': 'string',
          'description': 'string',
          'environmentBlueprintId': 'string',
          'projectId': 'string',
          'userParameters': [
              {
                  'keyName': 'string',
                  'description': 'string',
                  'fieldType': 'string',
                  'defaultValue': 'string',
                  'isEditable': True|False,
                  'isOptional': True|False,
                  'isUpdateSupported': True|False
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The identifier of the environment profile that is to be udpated.

        
      

      - **domainId** *(string) --* 

        The identifier of the Amazon DataZone domain in which the environment profile is to be updated.

        
      

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

        The Amazon Web Services account in which a specified environment profile is to be udpated.

        
      

      - **awsAccountRegion** *(string) --* 

        The Amazon Web Services Region in which a specified environment profile is to be updated.

        
      

      - **createdBy** *(string) --* 

        The Amazon DataZone user who created the environment profile.

        
      

      - **createdAt** *(datetime) --* 

        The timestamp of when the environment profile was created.

        
      

      - **updatedAt** *(datetime) --* 

        The timestamp of when the environment profile was updated.

        
      

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

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

        
      

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

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

        
      

      - **environmentBlueprintId** *(string) --* 

        The identifier of the blueprint of the environment profile that is to be updated.

        
      

      - **projectId** *(string) --* 

        The identifier of the project of the environment profile that is to be updated.

        
      

      - **userParameters** *(list) --* 

        The user parameters to be updated as part of the ``UpdateEnvironmentProfile`` action.

        
        

        - *(dict) --* 

          The details of user parameters of an environment blueprint.

          
          

          - **keyName** *(string) --* 

            The key name of the parameter.

            
          

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

            The description of the parameter.

            
          

          - **fieldType** *(string) --* 

            The filed type of the parameter.

            
          

          - **defaultValue** *(string) --* 

            The default value of the parameter.

            
          

          - **isEditable** *(boolean) --* 

            Specifies whether the parameter is editable.

            
          

          - **isOptional** *(boolean) --* 

            Specifies whether the custom parameter is optional.

            
          

          - **isUpdateSupported** *(boolean) --* 

            Specifies whether a parameter value can be updated after creation.

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

  