ConnectCases / Client / create_field

create_field#

ConnectCases.Client.create_field(**kwargs)#

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

See also: AWS API Documentation

Request Syntax

response = client.create_field(
    description='string',
    domainId='string',
    name='string',
    type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'
)
Parameters:

  • description (string) – The description of the field.

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • name (string) –

    [REQUIRED]

    The name of the field.

  • type (string) –

    [REQUIRED]

    Defines the data type, some system constraints, and default display of the field.

Return type:

dict

Returns:

Response Syntax

{
    'fieldArn': 'string',
    'fieldId': 'string'
}

Response Structure

  • (dict) –

    • fieldArn (string) –

      The Amazon Resource Name (ARN) of the field.

    • fieldId (string) –

      The unique identifier of a field.

Exceptions

  • ConnectCases.Client.exceptions.InternalServerException

  • ConnectCases.Client.exceptions.ResourceNotFoundException

  • ConnectCases.Client.exceptions.ValidationException

  • ConnectCases.Client.exceptions.ThrottlingException

  • ConnectCases.Client.exceptions.AccessDeniedException

  • ConnectCases.Client.exceptions.ConflictException

  • ConnectCases.Client.exceptions.ServiceQuotaExceededException