create_case

ConnectCases.Client.create_case(**kwargs)

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

Note

The following fields are required when creating a case:

<ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>

See also: AWS API Documentation

Request Syntax

response = client.create_case(
    clientToken='string',
    domainId='string',
    fields=[
        {
            'id': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'stringValue': 'string'
            }
        },
    ],
    templateId='string'
)

Parameters

• clientToken (string) --

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  This field is autopopulated if not provided.

• domainId (string) --

  [REQUIRED]

  The unique identifier of the Cases domain.

• fields (list) --

  [REQUIRED]

  An array of objects with field ID (matching ListFields/DescribeField) and value union data.

  • (dict) --

    Object for case field values.

    • id (string) -- [REQUIRED]

      Unique identifier of a field.

    • value (dict) -- [REQUIRED]

      Union of potential field value types.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

      • booleanValue (boolean) --

        Can be either null, or have a Boolean value type. Only one value can be provided.

      • doubleValue (float) --

        Can be either null, or have a Double number value type. Only one value can be provided.

      • stringValue (string) --

        String value type.

• templateId (string) --

  [REQUIRED]

  A unique identifier of a template.

Return type

dict

Returns

Response Syntax

{
    'caseArn': 'string',
    'caseId': 'string'
}

Response Structure

• (dict) --

  • caseArn (string) --

    The Amazon Resource Name (ARN) of the case.

  • caseId (string) --

    A unique identifier of the case.

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