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

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.

The following fields are required when creating a case:

customer_id - You must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID
title

Request Syntax

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

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
templateId (string) –
[REQUIRED]

A unique identifier of a template.
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: stringValue, doubleValue, booleanValue, emptyValue, userArnValue.
    - stringValue (string) –
      
      String value type.
    - doubleValue (float) –
      
      Can be either null, or have a Double number value type. Only one value can be provided.
    - booleanValue (boolean) –
      
      Can be either null, or have a Boolean value type. Only one value can be provided.
    - emptyValue (dict) –
      
      An empty value.
    - userArnValue (string) –
      
      Represents the user that performed the audit.
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.
performedBy (dict) –
Represents the entity that performed the action.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: userArn, customEntity.
- userArn (string) –
  
  Represents the Amazon Connect ARN of the user.
- customEntity (string) –
  
  Any provided entity.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- caseId (string) –
  
  A unique identifier of the case.
- caseArn (string) –
  
  The Amazon Resource Name (ARN) 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