ConnectCases / Client / create_case

create_case#

ConnectCases.Client.create_case(**kwargs)#

Note

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

`` <p>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.</p> <p>The following fields are required when creating a case:</p> <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/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>``

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,
                'emptyValue': {}
                ,
                'stringValue': 'string',
                'userArnValue': 'string'
            }
        },
    ],
    performedBy={
        'userArn': '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, emptyValue, stringValue, userArnValue.

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

        • emptyValue (dict) –

          An empty value.

        • stringValue (string) –

          String value type.

        • userArnValue (string) –

          Represents the user that performed the audit.

  • performedBy (dict) –

    Represents the identity of the person who performed the action.

    Note

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

    • userArn (string) –

      Represents the Amazon Connect ARN of the user.

  • 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