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

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.

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.

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

Link to this function

batch_get_field(Client, DomainId, Input)

View Source
Returns the description for the list of fields in the request parameters.
Link to this function

batch_get_field(Client, DomainId, Input0, Options0)

View Source
Link to this function

batch_put_field_options(Client, DomainId, FieldId, Input)

View Source
Creates and updates a set of field options for a single select field in a Cases domain.
Link to this function

batch_put_field_options(Client, DomainId, FieldId, Input0, Options0)

View Source
Link to this function

create_case(Client, DomainId, Input)

View Source

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.

customer_id is a required field when creating a case.
Link to this function

create_case(Client, DomainId, Input0, Options0)

View Source
Link to this function

create_domain(Client, Input)

View Source

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.
Link to this function

create_domain(Client, Input0, Options0)

View Source
Link to this function

create_field(Client, DomainId, Input)

View Source

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.
Link to this function

create_field(Client, DomainId, Input0, Options0)

View Source
Link to this function

create_layout(Client, DomainId, Input)

View Source

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.
Link to this function

create_layout(Client, DomainId, Input0, Options0)

View Source
Link to this function

create_template(Client, DomainId, Input)

View Source

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.
Link to this function

create_template(Client, DomainId, Input0, Options0)

View Source
Link to this function

get_case(Client, CaseId, DomainId, Input)

View Source
Returns information about a specific case if it exists.
Link to this function

get_case(Client, CaseId, DomainId, Input0, Options0)

View Source
Link to this function

get_case_event_configuration(Client, DomainId, Input)

View Source
Returns the case event publishing configuration.
Link to this function

get_case_event_configuration(Client, DomainId, Input0, Options0)

View Source
Link to this function

get_domain(Client, DomainId, Input)

View Source
Returns information about a specific domain if it exists.
Link to this function

get_domain(Client, DomainId, Input0, Options0)

View Source
Link to this function

get_layout(Client, DomainId, LayoutId, Input)

View Source
Returns the details for the requested layout.
Link to this function

get_layout(Client, DomainId, LayoutId, Input0, Options0)

View Source
Link to this function

get_template(Client, DomainId, TemplateId, Input)

View Source
Returns the details for the requested template.
Link to this function

get_template(Client, DomainId, TemplateId, Input0, Options0)

View Source
Link to this function

list_cases_for_contact(Client, DomainId, Input)

View Source
Lists cases for a given contact.
Link to this function

list_cases_for_contact(Client, DomainId, Input0, Options0)

View Source
Link to this function

list_domains(Client, Input)

View Source

Lists all cases domains in the Amazon Web Services account.

Each list item is a condensed summary object of the domain.
Link to this function

list_domains(Client, Input0, Options0)

View Source
Link to this function

list_field_options(Client, DomainId, FieldId, Input)

View Source
Lists all of the field options for a field identifier in the domain.
Link to this function

list_field_options(Client, DomainId, FieldId, Input0, Options0)

View Source
Link to this function

list_fields(Client, DomainId, Input)

View Source
Lists all fields in a Cases domain.
Link to this function

list_fields(Client, DomainId, Input0, Options0)

View Source
Link to this function

list_layouts(Client, DomainId, Input)

View Source

Lists all layouts in the given cases domain.

Each list item is a condensed summary object of the layout.
Link to this function

list_layouts(Client, DomainId, Input0, Options0)

View Source
Link to this function

list_tags_for_resource(Client, Arn)

View Source
Lists tags for a resource.
Link to this function

list_tags_for_resource(Client, Arn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, Arn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_templates(Client, DomainId, Input)

View Source

Lists all of the templates in a Cases domain.

Each list item is a condensed summary object of the template.
Link to this function

list_templates(Client, DomainId, Input0, Options0)

View Source
Link to this function

put_case_event_configuration(Client, DomainId, Input)

View Source
API for adding case event publishing configuration
Link to this function

put_case_event_configuration(Client, DomainId, Input0, Options0)

View Source
Link to this function

search_cases(Client, DomainId, Input)

View Source

Searches for cases within their associated Cases domain.

Search results are returned as a paginated list of abridged case documents.
Link to this function

search_cases(Client, DomainId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, Arn, Input)

View Source
Adds tags to a resource.
Link to this function

tag_resource(Client, Arn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, Arn, Input)

View Source
Untags a resource.
Link to this function

untag_resource(Client, Arn, Input0, Options0)

View Source
Link to this function

update_case(Client, CaseId, DomainId, Input)

View Source

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.
Link to this function

update_case(Client, CaseId, DomainId, Input0, Options0)

View Source
Link to this function

update_field(Client, DomainId, FieldId, Input)

View Source
Updates the properties of an existing field.
Link to this function

update_field(Client, DomainId, FieldId, Input0, Options0)

View Source
Link to this function

update_layout(Client, DomainId, LayoutId, Input)

View Source

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.
Link to this function

update_layout(Client, DomainId, LayoutId, Input0, Options0)

View Source
Link to this function

update_template(Client, DomainId, TemplateId, Input)

View Source

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.
Link to this function

update_template(Client, DomainId, TemplateId, Input0, Options0)

View Source