View Source aws_connectcases (aws v0.7.14)
Welcome to the Amazon Connect Cases API Reference.
This guide provides information about the Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains, fields, field options, layouts, templates, cases, related items, and tags.
<p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>. </p>Link to this section Summary
Functions
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.
Lists all cases domains in the Amazon Web Services account.
Lists all layouts in the given cases domain.
Lists all of the templates in a Cases domain.
Searches for cases within their associated Cases domain.
Searches for related items that are associated with a case.
Updates the values of fields on a case.
Updates the attributes of an existing layout.
Updates the attributes of an existing template.
Link to this section Functions
batch_put_field_options(Client, DomainId, FieldId, Input0, Options0)
View SourceCreates 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.
customer_id
is a required field when creating a case.
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.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
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.Lists all cases domains in the Amazon Web Services account.
Each list item is a condensed summary object of the domain.Lists all layouts in the given cases domain.
Each list item is a condensed summary object of the layout.list_tags_for_resource(Client, Arn, QueryMap, HeadersMap, Options0)
View SourceLists all of the templates in a Cases domain.
Each list item is a condensed summary object of the template.Searches for cases within their associated Cases domain.
Search results are returned as a paginated list of abridged case documents.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 .
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.
Updates the attributes of an existing template.
The template attributes that can be modified includename
, 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.