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

******************
list_field_options
******************



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

  

  Lists all of the field options for a field identifier in the domain.

  

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


  **Request Syntax**
  ::

    response = client.list_field_options(
        domainId='string',
        fieldId='string',
        maxResults=123,
        nextToken='string',
        values=[
            'string',
        ]
    )
    
  :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 maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

  
  :type values: list
  :param values: 

    A list of ``FieldOption`` values to filter on for ``ListFieldOptions``.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'options': [
              {
                  'name': 'string',
                  'value': 'string',
                  'active': True|False
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **options** *(list) --* 

        A list of ``FieldOption`` objects.

        
        

        - *(dict) --* 

          Object for field Options information.

          
          

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

            ``FieldOptionName`` has max length 100 and disallows trailing spaces.

            
          

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

            ``FieldOptionValue`` has max length 100 and must be alphanumeric with hyphens and underscores.

            
          

          - **active** *(boolean) --* 

            Describes whether the ``FieldOption`` is active (displayed) or inactive.

            
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results. This is null if there are no more results to return.

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

  