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' => [
        [
            '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

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

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' => [
        'userArn' => '<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.

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.

 </important> 

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

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

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([
    '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.

 </note> 

$result = $client->createRelatedItem([
    'caseId' => '<string>', // REQUIRED
    'content' => [ // REQUIRED
        'comment' => [
            'body' => '<string>', // REQUIRED
            'contentType' => 'Text/Plain', // REQUIRED
        ],
        'contact' => [
            'contactArn' => '<string>', // REQUIRED
        ],
        'file' => [
            'fileArn' => '<string>', // REQUIRED
        ],
    ],
    'domainId' => '<string>', // REQUIRED
    'performedBy' => [
        'userArn' => '<string>',
    ],
    'type' => 'Contact|Comment|File', // REQUIRED
]);

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

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.

Parameter Syntax

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

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.

DeleteDomain

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

Deletes a Cases domain.

 <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note> 

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. You can delete up to 100 fields per domain.

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 IDs in the request have been deleted.

• Calling GetCase with a deleted field ID 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.

 <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul> 

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.

DeleteTemplate

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

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

 <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul> 

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' => [
                    'userArn' => '<string>',
                ],
            ],
            'performedTime' => <DateTime>,
            'relatedItemType' => 'Contact|Comment|File',
            'type' => 'Case.Created|Case.Updated|RelatedItem.Created',
        ],
        // ...
    ],
    '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.

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.

GetTemplate

$result = $client->getTemplate([/* ... */]);
$promise = $client->getTemplateAsync([/* ... */]);

Returns the details for the requested template.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'createdTime' => <DateTime>,
    'deleted' => true || false,
    'description' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'layoutConfiguration' => [
        'defaultLayout' => '<string>',
    ],
    'name' => '<string>',
    'requiredFields' => [
        [
            'fieldId' => '<string>',
        ],
        // ...
    ],
    'status' => 'Active|Inactive',
    'tags' => ['<string>', ...],
    '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.

ListCasesForContact

$result = $client->listCasesForContact([/* ... */]);
$promise = $client->listCasesForContactAsync([/* ... */]);

Lists cases for a given contact.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'cases' => [
        [
            'caseId' => '<string>',
            'templateId' => '<string>',
        ],
        // ...
    ],
    '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.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

Parameter Syntax

$result = $client->listDomains([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'domains' => [
        [
            'domainArn' => '<string>',
            'domainId' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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.

ListFieldOptions

$result = $client->listFieldOptions([/* ... */]);
$promise = $client->listFieldOptionsAsync([/* ... */]);

Lists all of the field options for a field identifier in the domain.

Parameter Syntax

$result = $client->listFieldOptions([
    'domainId' => '<string>', // REQUIRED
    'fieldId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'values' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'options' => [
        [
            'active' => true || false,
            'name' => '<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.

ListFields

$result = $client->listFields([/* ... */]);
$promise = $client->listFieldsAsync([/* ... */]);

Lists all fields in a Cases domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'fields' => [
        [
            'fieldArn' => '<string>',
            'fieldId' => '<string>',
            'name' => '<string>',
            'namespace' => 'System|Custom',
            'type' => 'Text|Number|Boolean|DateTime|SingleSelect|Url|User',
        ],
        // ...
    ],
    '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.

ListLayouts

$result = $client->listLayouts([/* ... */]);
$promise = $client->listLayoutsAsync([/* ... */]);

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'layouts' => [
        [
            'layoutArn' => '<string>',
            'layoutId' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    '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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    '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.

ListTemplates

$result = $client->listTemplates([/* ... */]);
$promise = $client->listTemplatesAsync([/* ... */]);

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'templates' => [
        [
            'name' => '<string>',
            'status' => 'Active|Inactive',
            '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.

PutCaseEventConfiguration

$result = $client->putCaseEventConfiguration([/* ... */]);
$promise = $client->putCaseEventConfigurationAsync([/* ... */]);

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide

Parameter Syntax

$result = $client->putCaseEventConfiguration([
    'domainId' => '<string>', // REQUIRED
    'eventBridge' => [ // REQUIRED
        'enabled' => true || false, // REQUIRED
        'includedData' => [
            'caseData' => [
                'fields' => [ // REQUIRED
                    [
                        'id' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'relatedItemData' => [
                'includeContent' => true || false, // 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.

SearchCases

$result = $client->searchCases([/* ... */]);
$promise = $client->searchCasesAsync([/* ... */]);

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

Parameter Syntax

$result = $client->searchCases([
    'domainId' => '<string>', // REQUIRED
    'fields' => [
        [
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'filter' => [
        'andAll' => [
            [...], // RECURSIVE
            // ...
        ],
        'field' => [
            'contains' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
            'equalTo' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
            'greaterThan' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
            'greaterThanOrEqualTo' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
            'lessThan' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
            'lessThanOrEqualTo' => [
                'id' => '<string>', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'emptyValue' => [
                    ],
                    'stringValue' => '<string>',
                    'userArnValue' => '<string>',
                ],
            ],
        ],
        'not' => [...], // RECURSIVE
        'orAll' => [
            [...], // RECURSIVE
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchTerm' => '<string>',
    'sorts' => [
        [
            'fieldId' => '<string>', // REQUIRED
            'sortOrder' => 'Asc|Desc', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'cases' => [
        [
            'caseId' => '<string>',
            'fields' => [
                [
                    'id' => '<string>',
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'emptyValue' => [
                        ],
                        'stringValue' => '<string>',
                        'userArnValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
            'templateId' => '<string>',
        ],
        // ...
    ],
    '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.

SearchRelatedItems

$result = $client->searchRelatedItems([/* ... */]);
$promise = $client->searchRelatedItemsAsync([/* ... */]);

Searches for related items that are associated with a case.

Parameter Syntax

$result = $client->searchRelatedItems([
    'caseId' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
    'filters' => [
        [
            'comment' => [
            ],
            'contact' => [
                'channel' => ['<string>', ...],
                'contactArn' => '<string>',
            ],
            'file' => [
                'fileArn' => '<string>',
            ],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'relatedItems' => [
        [
            'associationTime' => <DateTime>,
            'content' => [
                'comment' => [
                    'body' => '<string>',
                    'contentType' => 'Text/Plain',
                ],
                'contact' => [
                    'channel' => '<string>',
                    'connectedToSystemTime' => <DateTime>,
                    'contactArn' => '<string>',
                ],
                'file' => [
                    'fileArn' => '<string>',
                ],
            ],
            'performedBy' => [
                'userArn' => '<string>',
            ],
            'relatedItemId' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'Contact|Comment|File',
        ],
        // ...
    ],
]

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'arn' => '<string>', // REQUIRED
    'tags' => ['<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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untags a resource.

Parameter Syntax

$result = $client->untagResource([
    'arn' => '<string>', // REQUIRED
    'tagKeys' => ['<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.

UpdateCase

$result = $client->updateCase([/* ... */]);
$promise = $client->updateCaseAsync([/* ... */]);

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

 <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> 

Parameter Syntax

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

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.

UpdateField

$result = $client->updateField([/* ... */]);
$promise = $client->updateFieldAsync([/* ... */]);

Updates the properties of an existing field.

Parameter Syntax

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

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.

UpdateLayout

$result = $client->updateLayout([/* ... */]);
$promise = $client->updateLayoutAsync([/* ... */]);

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

Parameter Syntax

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

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.

UpdateTemplate

$result = $client->updateTemplate([/* ... */]);
$promise = $client->updateTemplateAsync([/* ... */]);

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Parameter Syntax

$result = $client->updateTemplate([
    'description' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'layoutConfiguration' => [
        'defaultLayout' => '<string>',
    ],
    'name' => '<string>',
    'requiredFields' => [
        [
            'fieldId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'status' => 'Active|Inactive',
    '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.