SDK for PHP 3.x

Client: Aws\ConnectCases\ConnectCasesClient
Service ID: connectcases
Version: 2022-10-03

This page describes the parameters and results for the operations of the Amazon Connect Cases (2022-10-03), and shows how to use the Aws\ConnectCases\ConnectCasesClient object to call the described operations. This documentation is specific to the 2022-10-03 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchGetField ( array $params = [] )
Returns the description for the list of fields in the request parameters.
BatchPutFieldOptions ( array $params = [] )
Creates and updates a set of field options for a single select field in a Cases domain.
CreateCase ( array $params = [] )
If you provide a value for PerformedBy.
CreateDomain ( array $params = [] )
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
CreateField ( array $params = [] )
Creates a field in the Cases domain.
CreateLayout ( array $params = [] )
Creates a layout in the Cases domain.
CreateRelatedItem ( array $params = [] )
Creates a related item (comments, tasks, and contacts) and associates it with a case.
CreateTemplate ( array $params = [] )
Creates a template in the Cases domain.
DeleteDomain ( array $params = [] )
Deletes a Cases domain.
DeleteField ( array $params = [] )
Deletes a field from a cases template.
DeleteLayout ( array $params = [] )
Deletes a layout from a cases template.
DeleteTemplate ( array $params = [] )
Deletes a cases template.
GetCase ( array $params = [] )
Returns information about a specific case if it exists.
GetCaseAuditEvents ( array $params = [] )
Returns the audit history about a specific case if it exists.
GetCaseEventConfiguration ( array $params = [] )
Returns the case event publishing configuration.
GetDomain ( array $params = [] )
Returns information about a specific domain if it exists.
GetLayout ( array $params = [] )
Returns the details for the requested layout.
GetTemplate ( array $params = [] )
Returns the details for the requested template.
ListCasesForContact ( array $params = [] )
Lists cases for a given contact.
ListDomains ( array $params = [] )
Lists all cases domains in the Amazon Web Services account.
ListFieldOptions ( array $params = [] )
Lists all of the field options for a field identifier in the domain.
ListFields ( array $params = [] )
Lists all fields in a Cases domain.
ListLayouts ( array $params = [] )
Lists all layouts in the given cases domain.
ListTagsForResource ( array $params = [] )
Lists tags for a resource.
ListTemplates ( array $params = [] )
Lists all of the templates in a Cases domain.
PutCaseEventConfiguration ( array $params = [] )
Adds case event publishing configuration.
SearchCases ( array $params = [] )
Searches for cases within their associated Cases domain.
SearchRelatedItems ( array $params = [] )
Searches for related items that are associated with a case.
TagResource ( array $params = [] )
Adds tags to a resource.
UntagResource ( array $params = [] )
Untags a resource.
UpdateCase ( array $params = [] )
If you provide a value for PerformedBy.
UpdateField ( array $params = [] )
Updates the properties of an existing field.
UpdateLayout ( array $params = [] )
Updates the attributes of an existing layout.
UpdateTemplate ( array $params = [] )
Updates the attributes of an existing template.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetCase
GetCaseAuditEvents
ListCasesForContact
ListDomains
ListFieldOptions
ListFields
ListLayouts
ListTemplates
SearchCases
SearchRelatedItems

Operations

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fields
Required: Yes
Type: Array of FieldIdentifier structures

A list of unique field identifiers.

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

Members
errors
Required: Yes
Type: Array of FieldError structures

A list of field errors.

fields
Required: Yes
Type: Array of GetFieldResponse structures

A list of detailed field information.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fieldId
Required: Yes
Type: string

The unique identifier of a field.

options
Required: Yes
Type: Array of FieldOption structures

A list of FieldOption objects.

Result Syntax

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

Result Details

Members
errors
Type: Array of FieldOptionError structures

A list of field errors.

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

Members
clientToken
Type: string

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

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fields
Required: Yes
Type: Array of FieldValue structures

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

performedBy
Type: UserUnion structure

Represents the identity of the person who performed the action.

templateId
Required: Yes
Type: string

A unique identifier of a template.

Result Syntax

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

Result Details

Members
caseArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the case.

caseId
Required: Yes
Type: string

A unique identifier of the case.

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.

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

 </important> 

Parameter Syntax

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

Parameter Details

Members
name
Required: Yes
Type: string

The name for your Cases domain. It must be unique for your Amazon Web Services account.

Result Syntax

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

Result Details

Members
domainArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Cases domain.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

domainStatus
Required: Yes
Type: string

The status of the domain.

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([
    'description' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'type' => 'Text|Number|Boolean|DateTime|SingleSelect|Url|User', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the field.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

name
Required: Yes
Type: string

The name of the field.

type
Required: Yes
Type: string

Defines the data type, some system constraints, and default display of the field.

Result Syntax

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

Result Details

Members
fieldArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the field.

fieldId
Required: Yes
Type: string

The unique identifier of a field.

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

Title and Status fields cannot be part of layouts since they are not configurable.

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

Members
content
Required: Yes
Type: LayoutContent structure

Information about which fields will be present in the layout, and information about the order of the fields.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

name
Required: Yes
Type: string

The name of the layout. It must be unique for the Cases domain.

Result Syntax

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

Result Details

Members
layoutArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the newly created layout.

layoutId
Required: Yes
Type: string

The unique identifier of the layout.

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.

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

 </note> 

Parameter Syntax

$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
]);

Parameter Details

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

content
Required: Yes
Type: RelatedItemInputContent structure

The content of a related item to be created.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

performedBy
Type: UserUnion structure

Represents the creator of the related item.

type
Required: Yes
Type: string

The type of a related item.

Result Syntax

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

Result Details

Members
relatedItemArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the related item.

relatedItemId
Required: Yes
Type: string

The unique identifier of the related item.

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.

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

Members
description
Type: string

A brief description of the template.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

layoutConfiguration
Type: LayoutConfiguration structure

Configuration of layouts associated to the template.

name
Required: Yes
Type: string

A name for the template. It must be unique per domain.

requiredFields
Type: Array of RequiredField structures

A list of fields that must contain a value for a case to be successfully created with this template.

status
Type: string

The status of the template.

Result Syntax

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

Result Details

Members
templateArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the newly created template.

templateId
Required: Yes
Type: string

A unique identifier of a template.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fieldId
Required: Yes
Type: string

Unique identifier of the field.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

layoutId
Required: Yes
Type: string

The unique identifier of the layout.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

templateId
Required: Yes
Type: string

A unique identifier of a template.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fields
Required: Yes
Type: Array of FieldIdentifier structures

A list of unique field identifiers.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

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

Result Details

Members
fields
Required: Yes
Type: Array of FieldValue structures

A list of detailed field information.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

templateId
Required: Yes
Type: string

A unique identifier of a template.

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

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

maxResults
Type: int

The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

Members
auditEvents
Required: Yes
Type: Array of AuditEvent structures

A list of case audits where each represents a particular edit of the case.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

Result Syntax

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

Result Details

Members
eventBridge
Required: Yes
Type: EventBridgeConfiguration structure

Configuration to enable EventBridge case event delivery and determine what data is delivered.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

Result Syntax

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

Result Details

Members
createdTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the Cases domain was created.

domainArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Cases domain.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

domainStatus
Required: Yes
Type: string

The status of the Cases domain.

name
Required: Yes
Type: string

The name of the Cases domain.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

layoutId
Required: Yes
Type: string

The unique identifier of the layout.

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

Members
content
Required: Yes
Type: LayoutContent structure

Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

createdTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created.

deleted
Type: boolean

Denotes whether or not the resource has been deleted.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created or last modified.

layoutArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the newly created layout.

layoutId
Required: Yes
Type: string

The unique identifier of the layout.

name
Required: Yes
Type: string

The name of the layout. It must be unique.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

templateId
Required: Yes
Type: string

A unique identifier of a template.

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

Members
createdTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created.

deleted
Type: boolean

Denotes whether or not the resource has been deleted.

description
Type: string

A brief description of the template.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created or last modified.

layoutConfiguration
Type: LayoutConfiguration structure

Configuration of layouts associated to the template.

name
Required: Yes
Type: string

The name of the template.

requiredFields
Type: Array of RequiredField structures

A list of fields that must contain a value for a case to be successfully created with this template.

status
Required: Yes
Type: string

The status of the template.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

templateArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the template.

templateId
Required: Yes
Type: string

A unique identifier of a template.

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

Members
contactArn
Required: Yes
Type: string

A unique identifier of a contact in Amazon Connect.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'cases' => [
        [
            'caseId' => '<string>',
            'templateId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
cases
Required: Yes
Type: Array of CaseSummary structures

A list of Case summary information.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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

Members
maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

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

Result Details

Members
domains
Required: Yes
Type: Array of DomainSummary structures

The Cases domain.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fieldId
Required: Yes
Type: string

The unique identifier of a field.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

values
Type: Array of strings

A list of FieldOption values to filter on for ListFieldOptions.

Result Syntax

[
    'nextToken' => '<string>',
    'options' => [
        [
            'active' => true || false,
            'name' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

options
Required: Yes
Type: Array of FieldOption structures

A list of FieldOption objects.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

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

Result Details

Members
fields
Required: Yes
Type: Array of FieldSummary structures

List of detailed field information.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'layouts' => [
        [
            'layoutArn' => '<string>',
            'layoutId' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
layouts
Required: Yes
Type: Array of LayoutSummary structures

The layouts for the domain.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN)

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

status
Type: Array of strings

A list of status values to filter on.

Result Syntax

[
    'nextToken' => '<string>',
    'templates' => [
        [
            'name' => '<string>',
            'status' => 'Active|Inactive',
            'templateArn' => '<string>',
            'templateId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

templates
Required: Yes
Type: Array of TemplateSummary structures

List of template summary objects.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

eventBridge
Required: Yes
Type: EventBridgeConfiguration structure

Configuration to enable EventBridge case event delivery and determine what data is delivered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.

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

Members
domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fields
Type: Array of FieldIdentifier structures

The list of field identifiers to be returned as part of the response.

filter
Type: CaseFilter structure

A list of filter objects.

maxResults
Type: int

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchTerm
Type: string

A word or phrase used to perform a quick search.

sorts
Type: Array of Sort structures

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

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

Members
cases
Required: Yes
Type: Array of SearchCasesResponseItem structures

A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

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.

If no filters are provided, this returns all related items 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

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

filters
Type: Array of RelatedItemTypeFilter structures

The list of types of related items and their parameters to use for filtering.

maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

Members
nextToken
Type: string

The token for the next set of results. This is null if there are no more results to return.

relatedItems
Required: Yes
Type: Array of SearchRelatedItemsResponseItem structures

A list of items related to a case.

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

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN)

tags
Required: Yes
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN)

tagKeys
Required: Yes
Type: Array of strings

List of tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fields
Required: Yes
Type: Array of FieldValue structures

An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.

performedBy
Type: UserUnion structure

Represents the identity of the person who performed the action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
description
Type: string

The description of a field.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

fieldId
Required: Yes
Type: string

The unique identifier of a field.

name
Type: string

The name of the field.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Title and Status fields cannot be part of layouts because they are not configurable.

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

Members
content
Type: LayoutContent structure

Information about which fields will be present in the layout, the order of the fields.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

layoutId
Required: Yes
Type: string

The unique identifier of the layout.

name
Type: string

The name of the layout. It must be unique per domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
description
Type: string

A brief description of the template.

domainId
Required: Yes
Type: string

The unique identifier of the Cases domain.

layoutConfiguration
Type: LayoutConfiguration structure

Configuration of layouts associated to the template.

name
Type: string

The name of the template. It must be unique per domain.

requiredFields
Type: Array of RequiredField structures

A list of fields that must contain a value for a case to be successfully created with this template.

status
Type: string

The status of the template.

templateId
Required: Yes
Type: string

A unique identifier for the template.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

AuditEvent

Description

Represents the content of a particular audit event.

Members
eventId
Required: Yes
Type: string

Unique identifier of a case audit history event.

fields
Required: Yes
Type: Array of AuditEventField structures

A list of Case Audit History event fields.

performedBy
Type: AuditEventPerformedBy structure

Information of the user which performed the audit.

performedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which an Audit History event took place.

relatedItemType
Type: string

The Type of the related item.

type
Required: Yes
Type: string

The Type of an audit history event.

AuditEventField

Description

Fields for audit event.

Members
eventFieldId
Required: Yes
Type: string

Unique identifier of field in an Audit History entry.

newValue
Required: Yes
Type: AuditEventFieldValueUnion structure

Union of potential field value types.

oldValue
Type: AuditEventFieldValueUnion structure

Union of potential field value types.

AuditEventFieldValueUnion

Description

Object to store union of Field values.

Members
booleanValue
Type: boolean

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

doubleValue
Type: double

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

emptyValue
Type: EmptyFieldValue structure

An empty value. You cannot set EmptyFieldValue on a field that is required on a case template.

This structure will never have any data members. It signifies an empty value on a case field.

stringValue
Type: string

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

userArnValue
Type: string

Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.

AuditEventPerformedBy

Description

Information of the user which performed the audit.

Members
iamPrincipalArn
Required: Yes
Type: string

Unique identifier of an IAM role.

user
Type: UserUnion structure

Represents the identity of the person who performed the action.

BasicLayout

Description

Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of agent application.

Members
moreInfo
Type: LayoutSections structure

This represents sections in a tab of the page layout.

topPanel
Type: LayoutSections structure

This represents sections in a panel of the page layout.

CaseEventIncludedData

Description

Details of what case data is published through the case event stream.

Members
fields
Required: Yes
Type: Array of FieldIdentifier structures

List of field identifiers.

CaseFilter

Description

A filter for cases. Only one value can be provided.

Members
andAll
Type: Array of CaseFilter structures

Provides "and all" filtering.

field
Type: FieldFilter structure

A list of fields to filter on.

not
Type: CaseFilter structure

A filter for cases. Only one value can be provided.

orAll
Type: Array of CaseFilter structures

Provides "or all" filtering.

CaseSummary

Description

Case summary information.

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

templateId
Required: Yes
Type: string

A unique identifier of a template.

CommentContent

Description

Represents the content of a Comment to be returned to agents.

Members
body
Required: Yes
Type: string

Text in the body of a Comment on a case.

contentType
Required: Yes
Type: string

Type of the text in the box of a Comment on a case.

CommentFilter

Description

A filter for related items of type Comment.

Members

ConflictException

Description

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.

Members
message
Required: Yes
Type: string

Contact

Description

An object that represents an Amazon Connect contact object.

Members
contactArn
Required: Yes
Type: string

A unique identifier of a contact in Amazon Connect.

ContactContent

Description

An object that represents a content of an Amazon Connect contact object.

Members
channel
Required: Yes
Type: string

A list of channels to filter on for related items of type Contact.

connectedToSystemTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

contactArn
Required: Yes
Type: string

A unique identifier of a contact in Amazon Connect.

ContactFilter

Description

A filter for related items of type Contact.

Members
channel
Type: Array of strings

A list of channels to filter on for related items of type Contact.

contactArn
Type: string

A unique identifier of a contact in Amazon Connect.

DomainSummary

Description

Object for the summarized details of the domain.

Members
domainArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the domain.

domainId
Required: Yes
Type: string

The unique identifier of the domain.

name
Required: Yes
Type: string

The name of the domain.

EmptyFieldValue

Description

An empty value. You cannot set EmptyFieldValue on a field that is required on a case template.

This structure will never have any data members. It signifies an empty value on a case field.

Members

EventBridgeConfiguration

Description

Configuration to enable EventBridge case event delivery and determine what data is delivered.

Members
enabled
Required: Yes
Type: boolean

Indicates whether the to broadcast case event data to the customer.

includedData
Type: EventIncludedData structure

Details of what case and related item data is published through the case event stream.

EventIncludedData

Description

Details of what case and related item data is published through the case event stream.

Members
caseData
Type: CaseEventIncludedData structure

Details of what case data is published through the case event stream.

relatedItemData

Details of what related item data is published through the case event stream.

FieldError

Description

Object for errors on fields.

Members
errorCode
Required: Yes
Type: string

The error code from getting a field.

id
Required: Yes
Type: string

The field identifier that caused the error.

message
Type: string

The error message from getting a field.

FieldFilter

Description

A filter for fields. Only one value can be provided.

Members
contains
Type: FieldValue structure

Object containing field identifier and value information.

equalTo
Type: FieldValue structure

Object containing field identifier and value information.

greaterThan
Type: FieldValue structure

Object containing field identifier and value information.

greaterThanOrEqualTo
Type: FieldValue structure

Object containing field identifier and value information.

lessThan
Type: FieldValue structure

Object containing field identifier and value information.

lessThanOrEqualTo
Type: FieldValue structure

Object containing field identifier and value information.

FieldGroup

Description

Object for a group of fields and associated properties.

Members
fields
Required: Yes
Type: Array of FieldItem structures

Represents an ordered list containing field related information.

name
Type: string

Name of the field group.

FieldIdentifier

Description

Object for unique identifier of a field.

Members
id
Required: Yes
Type: string

Unique identifier of a field.

FieldItem

Description

Object for field related information.

Members
id
Required: Yes
Type: string

Unique identifier of a field.

FieldOption

Description

Object for field Options information.

Members
active
Required: Yes
Type: boolean

Describes whether the FieldOption is active (displayed) or inactive.

name
Required: Yes
Type: string

FieldOptionName has max length 100 and disallows trailing spaces.

value
Required: Yes
Type: string

FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.

FieldOptionError

Description

Object for field Options errors.

Members
errorCode
Required: Yes
Type: string

Error code from creating or updating field option.

message
Required: Yes
Type: string

Error message from creating or updating field option.

value
Required: Yes
Type: string

The field option value that caused the error.

FieldSummary

Description

Object for the summarized details of the field.

Members
fieldArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the field.

fieldId
Required: Yes
Type: string

The unique identifier of a field.

name
Required: Yes
Type: string

Name of the field.

namespace
Required: Yes
Type: string

The namespace of a field.

type
Required: Yes
Type: string

The type of a field.

FieldValue

Description

Object for case field values.

Members
id
Required: Yes
Type: string

Unique identifier of a field.

value
Required: Yes
Type: FieldValueUnion structure

Union of potential field value types.

FieldValueUnion

Description

Object to store union of Field values.

The Summary system field accepts 1500 characters while all other fields accept 500 characters.

Members
booleanValue
Type: boolean

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

doubleValue
Type: double

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

emptyValue
Type: EmptyFieldValue structure

An empty value.

stringValue
Type: string

String value type.

userArnValue
Type: string

Represents the user that performed the audit.

FileContent

Description

An object that represents a content of an Amazon Connect file object.

Members
fileArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of a File in Amazon Connect.

FileFilter

Description

A filter for related items of type File.

Members
fileArn
Type: string

The Amazon Resource Name (ARN) of the file.

GetFieldResponse

Description

Object to store detailed field information.

Members
createdTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created.

deleted
Type: boolean

Denotes whether or not the resource has been deleted.

description
Type: string

Description of the field.

fieldArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the field.

fieldId
Required: Yes
Type: string

Unique identifier of the field.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp at which the resource was created or last modified.

name
Required: Yes
Type: string

Name of the field.

namespace
Required: Yes
Type: string

Namespace of the field.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

type
Required: Yes
Type: string

Type of the field.

InternalServerException

Description

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

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

Advice to clients on when the call can be safely retried.

LayoutConfiguration

Description

Object to store configuration of layouts associated to the template.

Members
defaultLayout
Type: string

Unique identifier of a layout.

LayoutContent

Description

Object to store union of different versions of layout content.

Members
basic
Type: BasicLayout structure

Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

LayoutSections

Description

Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.

Members
sections
Type: Array of Section structures

Ordered list containing different kinds of sections that can be added.

LayoutSummary

Description

Object for the summarized details of the layout.

Members
layoutArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the layout.

layoutId
Required: Yes
Type: string

The unique identifier for of the layout.

name
Required: Yes
Type: string

The name of the layout.

RelatedItemContent

Description

Represents the content of a particular type of related item.

Members
comment
Type: CommentContent structure

Represents the content of a comment to be returned to agents.

contact
Type: ContactContent structure

Represents the content of a contact to be returned to agents.

file
Type: FileContent structure

Represents the content of a File to be returned to agents.

RelatedItemEventIncludedData

Description

Details of what related item data is published through the case event stream.

Members
includeContent
Required: Yes
Type: boolean

Details of what related item data is published through the case event stream.

RelatedItemInputContent

Description

Represents the content of a related item to be created.

Members
comment
Type: CommentContent structure

Represents the content of a comment to be returned to agents.

contact
Type: Contact structure

Object representing a contact in Amazon Connect as an API request field.

file
Type: FileContent structure

A file of related items.

RelatedItemTypeFilter

Description

The list of types of related items and their parameters to use for filtering.

Members
comment
Type: CommentFilter structure

A filter for related items of type Comment.

contact
Type: ContactFilter structure

A filter for related items of type Contact.

file
Type: FileFilter structure

A filter for related items of this type of File.

RequiredField

Description

List of fields that must have a value provided to create a case.

Members
fieldId
Required: Yes
Type: string

Unique identifier of a field.

ResourceNotFoundException

Description

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.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

Unique identifier of the resource affected.

resourceType
Required: Yes
Type: string

Type of the resource affected.

SearchCasesResponseItem

Description

A list of items that represent cases.

Members
caseId
Required: Yes
Type: string

A unique identifier of the case.

fields
Required: Yes
Type: Array of FieldValue structures

List of case field values.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

templateId
Required: Yes
Type: string

A unique identifier of a template.

SearchRelatedItemsResponseItem

Description

A list of items that represent RelatedItems.

Members
associationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which a related item was associated with a case.

content
Required: Yes
Type: RelatedItemContent structure

Represents the content of a particular type of related item.

performedBy
Type: UserUnion structure

Represents the creator of the related item.

relatedItemId
Required: Yes
Type: string

Unique identifier of a related item.

tags
Type: Associative array of custom strings keys (String) to strings

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

type
Required: Yes
Type: string

Type of a related item.

Section

Description

This represents a sections within a panel or tab of the page layout.

Members
fieldGroup
Type: FieldGroup structure

Consists of a group of fields and associated properties.

ServiceQuotaExceededException

Description

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

Members
message
Required: Yes
Type: string

Sort

Description

A structured set of sort terms.

Members
fieldId
Required: Yes
Type: string

Unique identifier of a field.

sortOrder
Required: Yes
Type: string

A structured set of sort terms

TemplateSummary

Description

Template summary information.

Members
name
Required: Yes
Type: string

The template name.

status
Required: Yes
Type: string

The status of the template.

templateArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the template.

templateId
Required: Yes
Type: string

The unique identifier for the template.

ThrottlingException

Description

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

Members
message
Required: Yes
Type: string

UserUnion

Description

Represents the identity of the person who performed the action.

Members
userArn
Type: string

Represents the Amazon Connect ARN of the user.

ValidationException

Description

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

Members
message
Required: Yes
Type: string