:doc:`ConnectCases <../../connectcases>` / Client / update_field

************
update_field
************



.. py:method:: ConnectCases.Client.update_field(**kwargs)

  

  Updates the properties of an existing field.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateField>`_  


  **Request Syntax**
  ::

    response = client.update_field(
        domainId='string',
        fieldId='string',
        name='string',
        description='string',
        attributes={
            'text': {
                'isMultiline': True|False
            }
        }
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    The unique identifier of the Cases domain.

    

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

    The unique identifier of a field.

    

  
  :type name: string
  :param name: 

    The name of the field.

    

  
  :type description: string
  :param description: 

    The description of a field.

    

  
  :type attributes: dict
  :param attributes: 

    Union of field attributes.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``text``. 

  
    - **text** *(dict) --* 

      Field attributes for Text field type.

      

    
      - **isMultiline** *(boolean) --* **[REQUIRED]** 

        Attribute that defines rendering component and validation.

        

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`ConnectCases.Client.exceptions.InternalServerException`

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

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

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

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

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

  