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': [
        {
            'fieldArn': 'string',
            'fieldId': 'string',
            'name': 'string',
            'namespace': 'System'|'Custom',
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • fields (list) --

    List of detailed field information.

    • (dict) --

      Object for the summarized details of the field.

      • fieldArn (string) --

        The Amazon Resource Name (ARN) of the field.

      • fieldId (string) --

        The unique identifier of a field.

      • name (string) --

        Name of the field.

      • namespace (string) --

        The namespace of a field.

      • type (string) --

        The type of a field.

  • 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