ConnectCases / Client / update_field

update_field

ConnectCases.Client.update_field(**kwargs)

Updates the properties of an existing field.

See also: AWS API Documentation

Request Syntax

response = client.update_field(
    domainId='string',
    fieldId='string',
    name='string',
    description='string',
    attributes={
        'text': {
            'isMultiline': True|False
        }
    }
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fieldId (string) –

    [REQUIRED]

    The unique identifier of a field.

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

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

  • attributes (dict) –

    Union of field attributes.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: text.

    • text (dict) –

      Field attributes for Text field type.

      • isMultiline (boolean) – [REQUIRED]

        Attribute that defines rendering component and validation.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

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