ConnectCases / Client / list_fields

list_fields

ConnectCases.Client.list_fields(**kwargs)

Lists all fields in a Cases domain.

See also: AWS API Documentation

Request Syntax

response = client.list_fields(
    domainId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• domainId (string) –

  [REQUIRED]

  The unique identifier of the Cases domain.

• maxResults (integer) – The maximum number of results to return per page.

• nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'fields': [
        {
            'fieldId': 'string',
            'fieldArn': 'string',
            'name': 'string',
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User',
            'namespace': 'System'|'Custom',
            'attributes': {
                'text': {
                    'isMultiline': True|False
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • fields (list) –

    List of detailed field information.

    • (dict) –

      Object for the summarized details of the field.

      • fieldId (string) –

        The unique identifier of a field.

      • fieldArn (string) –

        The Amazon Resource Name (ARN) of the field.

      • name (string) –

        Name of the field.

      • type (string) –

        The type of a field.

      • namespace (string) –

        The namespace of a field.

      • 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.

  • nextToken (string) –

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

Exceptions

• ConnectCases.Client.exceptions.InternalServerException

• ConnectCases.Client.exceptions.ResourceNotFoundException

• ConnectCases.Client.exceptions.ValidationException

• ConnectCases.Client.exceptions.ThrottlingException

• ConnectCases.Client.exceptions.AccessDeniedException