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

******************
update_environment
******************



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

  

  Updates the specified environment in Amazon DataZone.

  

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


  **Request Syntax**
  ::

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

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

    

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

    The identifier of the environment that is to be updated.

    

  
  :type name: string
  :param name: 

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

    

  
  :type description: string
  :param description: 

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

    

  
  :type glossaryTerms: list
  :param glossaryTerms: 

    The glossary terms to be updated as part of the ``UpdateEnvironment`` action.

    

  
    - *(string) --* 

    

  :type blueprintVersion: string
  :param blueprintVersion: 

    The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: ``latest``.

    

  
  :type userParameters: list
  :param userParameters: 

    The user parameters of the environment.

    

  
    - *(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.

        

      
    

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

    
    ::

      {
          'projectId': 'string',
          'id': 'string',
          'domainId': 'string',
          'createdBy': 'string',
          'createdAt': datetime(2015, 1, 1),
          'updatedAt': datetime(2015, 1, 1),
          'name': 'string',
          'description': 'string',
          'environmentProfileId': 'string',
          'awsAccountId': 'string',
          'awsAccountRegion': 'string',
          'provider': 'string',
          'provisionedResources': [
              {
                  'provider': 'string',
                  'name': 'string',
                  'value': 'string',
                  'type': 'string'
              },
          ],
          'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
          'environmentActions': [
              {
                  'type': 'string',
                  'auth': 'IAM'|'HTTPS',
                  'parameters': [
                      {
                          'key': 'string',
                          'value': 'string'
                      },
                  ]
              },
          ],
          'glossaryTerms': [
              'string',
          ],
          'userParameters': [
              {
                  'keyName': 'string',
                  'description': 'string',
                  'fieldType': 'string',
                  'defaultValue': 'string',
                  'isEditable': True|False,
                  'isOptional': True|False,
                  'isUpdateSupported': True|False
              },
          ],
          'lastDeployment': {
              'deploymentId': 'string',
              'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
              'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
              'failureReason': {
                  'code': 'string',
                  'message': 'string'
              },
              'messages': [
                  'string',
              ],
              'isDeploymentComplete': True|False
          },
          'provisioningProperties': {
              'cloudFormation': {
                  'templateUrl': 'string'
              }
          },
          'deploymentProperties': {
              'startTimeoutMinutes': 123,
              'endTimeoutMinutes': 123
          },
          'environmentBlueprintId': 'string',
          'environmentConfigurationId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The project identifier of the environment.

        
      

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

        The identifier of the environment that is to be updated.

        
      

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

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

        
      

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

        The Amazon DataZone user who created the environment.

        
      

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

        The timestamp of when the environment was created.

        
      

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

        The timestamp of when the environment was updated.

        
      

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

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

        
      

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

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

        
      

      - **environmentProfileId** *(string) --* 

        The profile identifier of the environment.

        
      

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

        The identifier of the Amazon Web Services account in which the environment is to be updated.

        
      

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

        The Amazon Web Services Region in which the environment is updated.

        
      

      - **provider** *(string) --* 

        The provider identifier of the environment.

        
      

      - **provisionedResources** *(list) --* 

        The provisioned resources to be updated as part of the ``UpdateEnvironment`` action.

        
        

        - *(dict) --* 

          The details of a provisioned resource of this Amazon DataZone environment.

          
          

          - **provider** *(string) --* 

            The provider of a provisioned resource of this Amazon DataZone environment.

            
          

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

            The name of a provisioned resource of this Amazon DataZone environment.

            
          

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

            The value of a provisioned resource of this Amazon DataZone environment.

            
          

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

            The type of a provisioned resource of this Amazon DataZone environment.

            
      
    
      

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

        The status to be updated as part of the ``UpdateEnvironment`` action.

        
      

      - **environmentActions** *(list) --* 

        The environment actions to be updated as part of the ``UpdateEnvironment`` action.

        
        

        - *(dict) --* 

          The configurable action of a Amazon DataZone environment.

          
          

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

            The type of a configurable action in a Amazon DataZone environment.

            
          

          - **auth** *(string) --* 

            The authentication type of a configurable action of a Amazon DataZone environment.

            
          

          - **parameters** *(list) --* 

            The parameters of a configurable action in a Amazon DataZone environment.

            
            

            - *(dict) --* 

              The details of the parameters for the configurable environment action.

              
              

              - **key** *(string) --* 

                The key of the configurable action parameter.

                
              

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

                The value of the configurable action parameter.

                
          
        
      
    
      

      - **glossaryTerms** *(list) --* 

        The glossary terms to be updated as part of the ``UpdateEnvironment`` action.

        
        

        - *(string) --* 
    
      

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

        The user parameters to be updated as part of the ``UpdateEnvironment`` 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.

            
      
    
      

      - **lastDeployment** *(dict) --* 

        The last deployment of the environment.

        
        

        - **deploymentId** *(string) --* 

          The identifier of the last deployment of the environment.

          
        

        - **deploymentType** *(string) --* 

          The type of the last deployment of the environment.

          
        

        - **deploymentStatus** *(string) --* 

          The status of the last deployment of the environment.

          
        

        - **failureReason** *(dict) --* 

          The failure reason of the last deployment of the environment.

          
          

          - **code** *(string) --* 

            The error code for the failure reason for the environment deployment.

            
          

          - **message** *(string) --* 

            The error message for the failure reason for the environment deployment.

            
      
        

        - **messages** *(list) --* 

          The messages of the last deployment of the environment.

          
          

          - *(string) --* 
      
        

        - **isDeploymentComplete** *(boolean) --* 

          Specifies whether the last deployment of the environment is complete.

          
    
      

      - **provisioningProperties** *(dict) --* 

        The provisioning properties to be updated as part of the ``UpdateEnvironment`` action.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``cloudFormation``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


      
        

        - **cloudFormation** *(dict) --* 

          The cloud formation properties included as part of the provisioning properties of an environment blueprint.

          
          

          - **templateUrl** *(string) --* 

            The template URL of the cloud formation provisioning properties of the environment blueprint.

            
      
    
      

      - **deploymentProperties** *(dict) --* 

        The deployment properties to be updated as part of the ``UpdateEnvironment`` action.

        
        

        - **startTimeoutMinutes** *(integer) --* 

          The start timeout of the environment blueprint deployment.

          
        

        - **endTimeoutMinutes** *(integer) --* 

          The end timeout of the environment blueprint deployment.

          
    
      

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

        The blueprint identifier of the environment.

        
      

      - **environmentConfigurationId** *(string) --* 

        The configuration ID of the environment.

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

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

  