ConnectCasesClient

Suggest an Edit

With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases  in the Amazon Connect Administrator Guide.

Installation

NPM
npm install @aws-sdk/client-connectcases
Yarn
yarn add @aws-sdk/client-connectcases
pnpm
pnpm add @aws-sdk/client-connectcases

ConnectCasesClient Operations

Command
Summary
BatchGetCaseRuleCommand

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

BatchGetFieldCommand

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

BatchPutFieldOptionsCommand

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

CreateCaseCommand

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

CreateCaseRuleCommand

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

CreateDomainCommand

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 .

CreateFieldCommand

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.

CreateLayoutCommand

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.

CreateRelatedItemCommand

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.

  • The type field is reserved for internal use only.

CreateTemplateCommand

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

Other template APIs are:

DeleteCaseRuleCommand

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

DeleteDomainCommand

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 .

DeleteFieldCommand

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.

DeleteLayoutCommand

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

After a layout is deleted:

  • You can still retrieve the layout by calling GetLayout.

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

  • Deleted layouts are not included in the ListLayouts response.

DeleteTemplateCommand

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

After a cases template is deleted:

  • You can still retrieve the template by calling GetTemplate.

  • You cannot update the template.

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

  • Deleted templates are not included in the ListTemplates response.

GetCaseAuditEventsCommand

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

GetCaseCommand

Returns information about a specific case if it exists.

GetCaseEventConfigurationCommand

Returns the case event publishing configuration.

GetDomainCommand

Returns information about a specific domain if it exists.

GetLayoutCommand

Returns the details for the requested layout.

GetTemplateCommand

Returns the details for the requested template. Other template APIs are:

ListCaseRulesCommand

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template .

ListCasesForContactCommand

Lists cases for a given contact.

ListDomainsCommand

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

ListFieldOptionsCommand

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

ListFieldsCommand

Lists all fields in a Cases domain.

ListLayoutsCommand

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

ListTagsForResourceCommand

Lists tags for a resource.

ListTemplatesCommand

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

Other template APIs are:

PutCaseEventConfigurationCommand

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

SearchCasesCommand

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.

SearchRelatedItemsCommand

Searches for related items that are associated with a case.

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

TagResourceCommand

Adds tags to a resource.

UntagResourceCommand

Untags a resource.

UpdateCaseCommand

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.

UpdateCaseRuleCommand

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

UpdateFieldCommand

Updates the properties of an existing field.

UpdateLayoutCommand

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.

UpdateTemplateCommand

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.

Other template APIs are:

ConnectCasesClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: ConnectCasesClientConfig