View Source AWS.ConnectCases (aws-elixir v0.13.3)
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.
Link to this section Summary
Functions
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.
Creates a case in the specified Cases domain.
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
Creates a field in the Cases domain.
Creates a layout in the Cases domain.
Creates a related item (comments, tasks, and contacts) and associates it with a case.
Creates a template in the Cases domain.
Deletes a domain.
Returns information 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.
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.
Lists tags for a resource.
Lists all of the templates in a Cases domain.
API for adding case event publishing configuration
Searches for cases within their associated Cases domain.
Searches for related items that are associated with a case.
Adds tags to a resource.
Untags a resource.
Updates the values of fields on a case.
Updates the properties of an existing field.
Updates the attributes of an existing layout.
Updates the attributes of an existing template.
Link to this section Functions
Returns the description for the list of fields in the request parameters.
batch_put_field_options(client, domain_id, field_id, input, options \\ [])
View SourceCreates and updates a set of field options for a single select field in a Cases domain.
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/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 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 domain.
Returns information about a specific case if it exists.
get_case_event_configuration(client, domain_id, input, options \\ [])
View SourceReturns the case event publishing configuration.
Returns information about a specific domain if it exists.
Returns the details for the requested layout.
get_template(client, domain_id, template_id, input, options \\ [])
View SourceReturns 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.
list_field_options(client, domain_id, field_id, input, options \\ [])
View SourceLists 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.
put_case_event_configuration(client, domain_id, input, options \\ [])
View SourceAPI for adding case event publishing configuration
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
.
Adds tags to a resource.
Untags a resource.
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.
update_template(client, domain_id, template_id, input, options \\ [])
View SourceUpdates 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.