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

***************
batch_get_field
***************



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

  

  Returns the description for the list of fields in the request parameters.

  

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


  **Request Syntax**
  ::

    response = client.batch_get_field(
        domainId='string',
        fields=[
            {
                'id': 'string'
            },
        ]
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    The unique identifier of the Cases domain.

    

  
  :type fields: list
  :param fields: **[REQUIRED]** 

    A list of unique field identifiers.

    

  
    - *(dict) --* 

      Object for unique identifier of a field.

      

    
      - **id** *(string) --* **[REQUIRED]** 

        Unique identifier of a field.

        

      
    

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

    
    ::

      {
          'fields': [
              {
                  'fieldId': 'string',
                  'name': 'string',
                  'fieldArn': 'string',
                  'description': 'string',
                  'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User',
                  'namespace': 'System'|'Custom',
                  'tags': {
                      'string': 'string'
                  },
                  'deleted': True|False,
                  'createdTime': datetime(2015, 1, 1),
                  'lastModifiedTime': datetime(2015, 1, 1),
                  'attributes': {
                      'text': {
                          'isMultiline': True|False
                      }
                  }
              },
          ],
          'errors': [
              {
                  'id': 'string',
                  'errorCode': 'string',
                  'message': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **fields** *(list) --* 

        A list of detailed field information.

        
        

        - *(dict) --* 

          Object to store detailed field information.

          
          

          - **fieldId** *(string) --* 

            Unique identifier of the field.

            
          

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

            Name of the field.

            
          

          - **fieldArn** *(string) --* 

            The Amazon Resource Name (ARN) of the field.

            
          

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

            Description of the field.

            
          

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

            Type of the field.

            
          

          - **namespace** *(string) --* 

            Namespace of the field.

            
          

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

            A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **deleted** *(boolean) --* 

            Denotes whether or not the resource has been deleted.

            
          

          - **createdTime** *(datetime) --* 

            Timestamp at which the resource was created.

            
          

          - **lastModifiedTime** *(datetime) --* 

            Timestamp at which the resource was created or last modified.

            
          

          - **attributes** *(dict) --* 

            Union of field attributes.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``text``.     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'}


          
            

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

              Field attributes for Text field type.

              
              

              - **isMultiline** *(boolean) --* 

                Attribute that defines rendering component and validation.

                
          
        
      
    
      

      - **errors** *(list) --* 

        A list of field errors.

        
        

        - *(dict) --* 

          Object for errors on fields.

          
          

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

            The field identifier that caused the error.

            
          

          - **errorCode** *(string) --* 

            The error code from getting a field.

            
          

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

            The error message from getting a field.

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

  