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

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

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

Creates a case in the specified Cases domain.

Case system and custom fields are taken as an array id/value pairs with a declared data types.

The following fields are required when creating a case:

*

customer_id - You must provide the full customer profile ARN in this format:

arn:aws:profile:your_AWS_Region:your_AWS_account
ID:domains/your_profiles_domain_name/profiles/profile_ID

*

title

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.

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.

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.

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.

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.

Deletes a Cases domain.

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

Returns information about a specific case if it exists.

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

Returns the case event publishing configuration.

Returns information about a specific domain if it exists.

Returns the details for the requested layout.

Returns the details for the requested template.

Lists cases for a given contact.

Lists all cases domains in the Amazon Web Services account.

Each list item is a condensed summary object of the domain.

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

Lists all fields in a Cases domain.

Lists all layouts in the given cases domain.

Each list item is a condensed summary object of the layout.

Lists tags for a resource.

Lists all of the templates in a Cases domain.

Each list item is a condensed summary object of the template.

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

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

.

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

Adds tags to a resource.

Untags a resource.

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

Updates the values of fields on a case.

Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

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

Updates the properties of an existing field.

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.

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.