BatchGetCaseRule

$result = $client->batchGetCaseRule([/* ... */]);
$promise = $client->batchGetCaseRuleAsync([/* ... */]);

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameter Syntax

$result = $client->batchGetCaseRule([
    'caseRules' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'caseRules' => [
        [
            'caseRuleArn' => '<string>',
            'caseRuleId' => '<string>',
            'createdTime' => <DateTime>,
            'deleted' => true || false,
            'description' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'name' => '<string>',
            'rule' => [
                'fieldOptions' => [
                    'childFieldId' => '<string>',
                    'parentChildFieldOptionsMappings' => [
                        [
                            'childFieldOptionValues' => ['<string>', ...],
                            'parentFieldOptionValue' => '<string>',
                        ],
                        // ...
                    ],
                    'parentFieldId' => '<string>',
                ],
                'hidden' => [
                    'conditions' => [
                        [
                            'andAll' => [
                                'conditions' => [...], // RECURSIVE
                            ],
                            'equalTo' => [
                                'operandOne' => [
                                    'fieldId' => '<string>',
                                ],
                                'operandTwo' => [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'emptyValue' => [
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                'result' => true || false,
                            ],
                            'notEqualTo' => [
                                'operandOne' => [
                                    'fieldId' => '<string>',
                                ],
                                'operandTwo' => [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'emptyValue' => [
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                'result' => true || false,
                            ],
                            'orAll' => [
                                'conditions' => [...], // RECURSIVE
                            ],
                        ],
                        // ...
                    ],
                    'defaultValue' => true || false,
                ],
                'required' => [
                    'conditions' => [
                        [
                            'andAll' => [
                                'conditions' => [...], // RECURSIVE
                            ],
                            'equalTo' => [
                                'operandOne' => [
                                    'fieldId' => '<string>',
                                ],
                                'operandTwo' => [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'emptyValue' => [
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                'result' => true || false,
                            ],
                            'notEqualTo' => [
                                'operandOne' => [
                                    'fieldId' => '<string>',
                                ],
                                'operandTwo' => [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'emptyValue' => [
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                'result' => true || false,
                            ],
                            'orAll' => [
                                'conditions' => [...], // RECURSIVE
                            ],
                        ],
                        // ...
                    ],
                    'defaultValue' => true || false,
                ],
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'errors' => [
        [
            'errorCode' => '<string>',
            'id' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'unprocessedCaseRules' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchGetField

$result = $client->batchGetField([/* ... */]);
$promise = $client->batchGetFieldAsync([/* ... */]);

Returns the description for the list of fields in the request parameters.

Parameter Syntax

$result = $client->batchGetField([
    'domainId' => '<string>', // REQUIRED
    'fields' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'id' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'fields' => [
        [
            'attributes' => [
                'text' => [
                    'isMultiline' => true || false,
                ],
            ],
            'createdTime' => <DateTime>,
            'deleted' => true || false,
            'description' => '<string>',
            'fieldArn' => '<string>',
            'fieldId' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'name' => '<string>',
            'namespace' => 'System|Custom',
            'tags' => ['<string>', ...],
            'type' => 'Text|Number|Boolean|DateTime|SingleSelect|Url|User',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchPutFieldOptions

$result = $client->batchPutFieldOptions([/* ... */]);
$promise = $client->batchPutFieldOptionsAsync([/* ... */]);

Creates and updates a set of field options for a single select field in a Cases domain.

Parameter Syntax

$result = $client->batchPutFieldOptions([
    'domainId' => '<string>', // REQUIRED
    'fieldId' => '<string>', // REQUIRED
    'options' => [ // REQUIRED
        [
            'active' => true || false, // REQUIRED
            'name' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'message' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateCase

$result = $client->createCase([/* ... */]);
$promise = $client->createCaseAsync([/* ... */]);

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.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

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

Parameter Syntax

$result = $client->createCase([
    'clientToken' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'fields' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
            'value' => [ // REQUIRED
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'emptyValue' => [
                ],
                'stringValue' => '<string>',
                'userArnValue' => '<string>',
            ],
        ],
        // ...
    ],
    'performedBy' => [
        'customEntity' => '<string>',
        'userArn' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'caseArn' => '<string>',
    'caseId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateCaseRule

$result = $client->createCaseRule([/* ... */]);
$promise = $client->createCaseRuleAsync([/* ... */]);

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameter Syntax

$result = $client->createCaseRule([
    'description' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'rule' => [ // REQUIRED
        'fieldOptions' => [
            'childFieldId' => '<string>',
            'parentChildFieldOptionsMappings' => [ // REQUIRED
                [
                    'childFieldOptionValues' => ['<string>', ...], // REQUIRED
                    'parentFieldOptionValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'parentFieldId' => '<string>',
        ],
        'hidden' => [
            'conditions' => [ // REQUIRED
                [
                    'andAll' => [
                        'conditions' => [...], // REQUIRED, RECURSIVE
                    ],
                    'equalTo' => [
                        'operandOne' => [ // REQUIRED
                            'fieldId' => '<string>',
                        ],
                        'operandTwo' => [ // REQUIRED
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'emptyValue' => [
                            ],
                            'stringValue' => '<string>',
                        ],
                        'result' => true || false, // REQUIRED
                    ],
                    'notEqualTo' => [
                        'operandOne' => [ // REQUIRED
                            'fieldId' => '<string>',
                        ],
                        'operandTwo' => [ // REQUIRED
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'emptyValue' => [
                            ],
                            'stringValue' => '<string>',
                        ],
                        'result' => true || false, // REQUIRED
                    ],
                    'orAll' => [
                        'conditions' => [...], // REQUIRED, RECURSIVE
                    ],
                ],
                // ...
            ],
            'defaultValue' => true || false, // REQUIRED
        ],
        'required' => [
            'conditions' => [ // REQUIRED
                [
                    'andAll' => [
                        'conditions' => [...], // REQUIRED, RECURSIVE
                    ],
                    'equalTo' => [
                        'operandOne' => [ // REQUIRED
                            'fieldId' => '<string>',
                        ],
                        'operandTwo' => [ // REQUIRED
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'emptyValue' => [
                            ],
                            'stringValue' => '<string>',
                        ],
                        'result' => true || false, // REQUIRED
                    ],
                    'notEqualTo' => [
                        'operandOne' => [ // REQUIRED
                            'fieldId' => '<string>',
                        ],
                        'operandTwo' => [ // REQUIRED
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'emptyValue' => [
                            ],
                            'stringValue' => '<string>',
                        ],
                        'result' => true || false, // REQUIRED
                    ],
                    'orAll' => [
                        'conditions' => [...], // REQUIRED, RECURSIVE
                    ],
                ],
                // ...
            ],
            'defaultValue' => true || false, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'caseRuleArn' => '<string>',
    'caseRuleId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

Parameter Syntax

$result = $client->createDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'domainArn' => '<string>',
    'domainId' => '<string>',
    'domainStatus' => 'Active|CreationInProgress|CreationFailed',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateField

$result = $client->createField([/* ... */]);
$promise = $client->createFieldAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createField([
    'attributes' => [
        'text' => [
            'isMultiline' => true || false, // REQUIRED
        ],
    ],
    'description' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'type' => 'Text|Number|Boolean|DateTime|SingleSelect|Url|User', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'fieldArn' => '<string>',
    'fieldId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateLayout

$result = $client->createLayout([/* ... */]);
$promise = $client->createLayoutAsync([/* ... */]);

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

• Fields to display to the users

• Field ordering

Parameter Syntax

$result = $client->createLayout([
    'content' => [ // REQUIRED
        'basic' => [
            'moreInfo' => [
                'sections' => [
                    [
                        'fieldGroup' => [
                            'fields' => [ // REQUIRED
                                [
                                    'id' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'name' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            'topPanel' => [
                'sections' => [
                    [
                        'fieldGroup' => [
                            'fields' => [ // REQUIRED
                                [
                                    'id' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'name' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'layoutArn' => '<string>',
    'layoutId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateRelatedItem

$result = $client->createRelatedItem([/* ... */]);
$promise = $client->createRelatedItemAsync([/* ... */]);

Creates a related item (comments, tasks, and contacts) and associates it with a case.

There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas.

Use cases

Following are examples of related items that you may want to associate with a case:

• Related contacts, such as calls, chats, emails tasks

• Comments, for agent notes

• SLAs, to capture target resolution goals

• Cases, to capture related Amazon Connect Cases

• Files, such as policy documentation or customer-provided attachments

• Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

Important things to know

• If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn.

• A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

• If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.

• The type field is reserved for internal use only.

Endpoints: See Amazon Connect endpoints and quotas.

Parameter Syntax

$result = $client->createRelatedItem([
    'caseId' => '<string>', // REQUIRED
    'content' => [ // REQUIRED
        'comment' => [
            'body' => '<string>', // REQUIRED
            'contentType' => 'Text/Plain', // REQUIRED
        ],
        'connectCase' => [
            'caseId' => '<string>', // REQUIRED
        ],
        'contact' => [
            'contactArn' => '<string>', // REQUIRED
        ],
        'custom' => [
            'fields' => [ // REQUIRED
                [
                    'id' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'emptyValue' => [
                        ],
                        'stringValue' => '<string>',
                        'userArnValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        'file' => [
            'fileArn' => '<string>', // REQUIRED
        ],
        'sla' => [
            'slaInputConfiguration' => [
                'fieldId' => '<string>',
                'name' => '<string>', // REQUIRED
                'targetFieldValues' => [
                    [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'emptyValue' => [
                        ],
                        'stringValue' => '<string>',
                        'userArnValue' => '<string>',
                    ],
                    // ...
                ],
                'targetSlaMinutes' => <integer>, // REQUIRED
                'type' => 'CaseField', // REQUIRED
            ],
        ],
    ],
    'domainId' => '<string>', // REQUIRED
    'performedBy' => [
        'customEntity' => '<string>',
        'userArn' => '<string>',
    ],
    'type' => 'Contact|Comment|File|Sla|ConnectCase|Custom', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'relatedItemArn' => '<string>',
    'relatedItemId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

CreateTemplate

$result = $client->createTemplate([/* ... */]);
$promise = $client->createTemplateAsync([/* ... */]);

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Other template APIs are:

• DeleteTemplate

• GetTemplate

• ListTemplates

• UpdateTemplate

Parameter Syntax

$result = $client->createTemplate([
    'description' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'layoutConfiguration' => [
        'defaultLayout' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'requiredFields' => [
        [
            'fieldId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'rules' => [
        [
            'caseRuleId' => '<string>', // REQUIRED
            'fieldId' => '<string>',
        ],
        // ...
    ],
    'status' => 'Active|Inactive',
    'tagPropagationConfigurations' => [
        [
            'resourceType' => 'Cases', // REQUIRED
            'tagMap' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'templateArn' => '<string>',
    'templateId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

DeleteCase

$result = $client->deleteCase([/* ... */]);
$promise = $client->deleteCaseAsync([/* ... */]);

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:

• Retrieve related items

• Access audit history

• Perform any operations that require the CaseID

Parameter Syntax

$result = $client->deleteCase([
    'caseId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteCaseRule

$result = $client->deleteCaseRule([/* ... */]);
$promise = $client->deleteCaseRuleAsync([/* ... */]);

Deletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameter Syntax

$result = $client->deleteCaseRule([
    'caseRuleId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Deletes a Cases domain.

Parameter Syntax

$result = $client->deleteDomain([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

DeleteField

$result = $client->deleteField([/* ... */]);
$promise = $client->deleteFieldAsync([/* ... */]);

Deletes a field from a cases template.

After a field is deleted:

• You can still retrieve the field by calling BatchGetField.

• You cannot update a deleted field by calling UpdateField; it throws a ValidationException.

• Deleted fields are not included in the ListFields response.

• Calling CreateCase with a deleted field throws a ValidationException denoting which field identifiers in the request have been deleted.

• Calling GetCase with a deleted field identifier returns the deleted field's value if one exists.

• Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.

• GetTemplate does not return field IDs for deleted fields.

• GetLayout does not return field IDs for deleted fields.

• Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.

• Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.

• Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.

• Calling GetCaseEventConfiguration does not return field IDs for deleted fields.

Parameter Syntax

$result = $client->deleteField([
    'domainId' => '<string>', // REQUIRED
    'fieldId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ServiceQuotaExceededException:

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

DeleteLayout

$result = $client->deleteLayout([/* ... */]);
$promise = $client->deleteLayoutAsync([/* ... */]);

Deletes a layout from a cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:

• You can still retrieve the layout by calling GetLayout.

• You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException.

• Deleted layouts are not included in the ListLayouts response.

Parameter Syntax

$result = $client->deleteLayout([
    'domainId' => '<string>', // REQUIRED
    'layoutId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

DeleteRelatedItem

$result = $client->deleteRelatedItem([/* ... */]);
$promise = $client->deleteRelatedItemAsync([/* ... */]);

Deletes the related item resource under a case.

Parameter Syntax

$result = $client->deleteRelatedItem([
    'caseId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
    'relatedItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteTemplate

$result = $client->deleteTemplate([/* ... */]);
$promise = $client->deleteTemplateAsync([/* ... */]);

Deletes a cases template. You can delete up to 100 templates per domain.

After a cases template is deleted:

• You can still retrieve the template by calling GetTemplate.

• You cannot update the template.

• You cannot create a case by using the deleted template.

• Deleted templates are not included in the ListTemplates response.

Parameter Syntax

$result = $client->deleteTemplate([
    'domainId' => '<string>', // REQUIRED
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

GetCase

$result = $client->getCase([/* ... */]);
$promise = $client->getCaseAsync([/* ... */]);

Returns information about a specific case if it exists.

Parameter Syntax

$result = $client->getCase([
    'caseId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
    'fields' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fields' => [
        [
            'id' => '<string>',
            'value' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'emptyValue' => [
                ],
                'stringValue' => '<string>',
                'userArnValue' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'tags' => ['<string>', ...],
    'templateId' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetCaseAuditEvents

$result = $client->getCaseAuditEvents([/* ... */]);
$promise = $client->getCaseAuditEventsAsync([/* ... */]);

Returns the audit history about a specific case if it exists.

Parameter Syntax

$result = $client->getCaseAuditEvents([
    'caseId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'auditEvents' => [
        [
            'eventId' => '<string>',
            'fields' => [
                [
                    'eventFieldId' => '<string>',
                    'newValue' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'emptyValue' => [
                        ],
                        'stringValue' => '<string>',
                        'userArnValue' => '<string>',
                    ],
                    'oldValue' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'emptyValue' => [
                        ],
                        'stringValue' => '<string>',
                        'userArnValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'performedBy' => [
                'iamPrincipalArn' => '<string>',
                'user' => [
                    'customEntity' => '<string>',
                    'userArn' => '<string>',
                ],
            ],
            'performedTime' => <DateTime>,
            'relatedItemType' => 'Contact|Comment|File|Sla|ConnectCase|Custom',
            'type' => 'Case.Created|Case.Updated|RelatedItem.Created|RelatedItem.Deleted|RelatedItem.Updated',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetCaseEventConfiguration

$result = $client->getCaseEventConfiguration([/* ... */]);
$promise = $client->getCaseEventConfigurationAsync([/* ... */]);

Returns the case event publishing configuration.

Parameter Syntax

$result = $client->getCaseEventConfiguration([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eventBridge' => [
        'enabled' => true || false,
        'includedData' => [
            'caseData' => [
                'fields' => [
                    [
                        'id' => '<string>',
                    ],
                    // ...
                ],
            ],
            'relatedItemData' => [
                'includeContent' => true || false,
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Returns information about a specific domain if it exists.

Parameter Syntax

$result = $client->getDomain([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdTime' => <DateTime>,
    'domainArn' => '<string>',
    'domainId' => '<string>',
    'domainStatus' => 'Active|CreationInProgress|CreationFailed',
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

The rate has been exceeded for this API. Please try again after a few minutes.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetLayout

$result = $client->getLayout([/* ... */]);
$promise = $client->getLayoutAsync([/* ... */]);

Returns the details for the requested layout.

Parameter Syntax

$result = $client->getLayout([
    'domainId' => '<string>', // REQUIRED
    'layoutId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'content' => [
        'basic' => [
            'moreInfo' => [
                'sections' => [
                    [
                        'fieldGroup' => [
                            'fields' => [
                                [
                                    'id' => '<string>',
                                ],
                                // ...
                            ],
                            'name' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            'topPanel' => [
                'sections' => [
                    [
                        'fieldGroup' => [
                            'fields' => [
                                [
                                    'id' => '<string>',
                                ],
                                // ...
                            ],
                            'name' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'createdTime' => <DateTime>,
    'deleted' => true || false,
    'lastModifiedTime' => <DateTime>,
    'layoutArn' => '<string>',
    'layoutId' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException:

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.