aws-elixir

View Source AWS.ConnectCases (aws-elixir v1.0.4)

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

batch_get_field(client, domain_id, input, options \\ [])

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

batch_put_field_options(client, domain_id, field_id, input, options \\ [])

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

create_case(client, domain_id, input, options \\ [])

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

create_domain(client, input, options \\ [])

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.

create_field(client, domain_id, input, options \\ [])

Creates a field in the Cases domain.

create_layout(client, domain_id, input, options \\ [])

Creates a layout in the Cases domain.

create_related_item(client, case_id, domain_id, input, options \\ [])

Creates a related item (comments, tasks, and contacts) and associates it with a case.

create_template(client, domain_id, input, options \\ [])

Creates a template in the Cases domain.

delete_domain(client, domain_id, input, options \\ [])

Deletes a Cases domain.

delete_field(client, domain_id, field_id, input, options \\ [])

Deletes a field from a cases template.

delete_layout(client, domain_id, layout_id, input, options \\ [])

Deletes a layout from a cases template.

delete_template(client, domain_id, template_id, input, options \\ [])

Deletes a cases template.

get_case(client, case_id, domain_id, input, options \\ [])

Returns information about a specific case if it exists.

get_case_audit_events(client, case_id, domain_id, input, options \\ [])

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

get_case_event_configuration(client, domain_id, input, options \\ [])

Returns the case event publishing configuration.

get_domain(client, domain_id, input, options \\ [])

Returns information about a specific domain if it exists.

get_layout(client, domain_id, layout_id, input, options \\ [])

Returns the details for the requested layout.

get_template(client, domain_id, template_id, input, options \\ [])

Returns the details for the requested template.

list_cases_for_contact(client, domain_id, input, options \\ [])

Lists cases for a given contact.

list_domains(client, input, options \\ [])

Lists all cases domains in the Amazon Web Services account.

list_field_options(client, domain_id, field_id, input, options \\ [])

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

list_fields(client, domain_id, input, options \\ [])

Lists all fields in a Cases domain.

list_layouts(client, domain_id, input, options \\ [])

Lists all layouts in the given cases domain.

list_tags_for_resource(client, arn, options \\ [])

Lists tags for a resource.

list_templates(client, domain_id, input, options \\ [])

Lists all of the templates in a Cases domain.

metadata()
put_case_event_configuration(client, domain_id, input, options \\ [])

Adds case event publishing configuration.

search_cases(client, domain_id, input, options \\ [])

Searches for cases within their associated Cases domain.

search_related_items(client, case_id, domain_id, input, options \\ [])

Searches for related items that are associated with a case.

tag_resource(client, arn, input, options \\ [])

Adds tags to a resource.

untag_resource(client, arn, input, options \\ [])

Untags a resource.

update_case(client, case_id, domain_id, input, options \\ [])

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

update_field(client, domain_id, field_id, input, options \\ [])

Updates the properties of an existing field.

update_layout(client, domain_id, layout_id, input, options \\ [])

Updates the attributes of an existing layout.

update_template(client, domain_id, template_id, input, options \\ [])

Updates the attributes of an existing template.

Link to this section Functions

Link to this function

batch_get_field(client, domain_id, input, options \\ [])

View Source

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

Link to this function

batch_put_field_options(client, domain_id, field_id, input, options \\ [])

View Source

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

Link to this function

create_case(client, domain_id, input, options \\ [])

View Source

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

Link to this function

create_domain(client, input, options \\ [])

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. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

Link to this function

create_field(client, domain_id, input, options \\ [])

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_layout(client, domain_id, input, options \\ [])

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_template(client, domain_id, input, options \\ [])

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

delete_domain(client, domain_id, input, options \\ [])

View Source

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.

Link to this function

delete_field(client, domain_id, field_id, input, options \\ [])

View Source

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.

Link to this function

delete_layout(client, domain_id, layout_id, input, options \\ [])

View Source

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.

Link to this function

delete_template(client, domain_id, template_id, input, options \\ [])

View Source

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.

Link to this function

get_case(client, case_id, domain_id, input, options \\ [])

View Source

Returns information about a specific case if it exists.

Link to this function

get_case_audit_events(client, case_id, domain_id, input, options \\ [])

View Source

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

Link to this function

get_case_event_configuration(client, domain_id, input, options \\ [])

View Source

Returns the case event publishing configuration.

Link to this function

get_domain(client, domain_id, input, options \\ [])

View Source

Returns information about a specific domain if it exists.

Link to this function

get_layout(client, domain_id, layout_id, input, options \\ [])

View Source

Returns the details for the requested layout.

Link to this function

get_template(client, domain_id, template_id, input, options \\ [])

View Source

Returns the details for the requested template.

Link to this function

list_cases_for_contact(client, domain_id, input, options \\ [])

View Source

Lists cases for a given contact.

Link to this function

list_domains(client, input, options \\ [])

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_field_options(client, domain_id, field_id, input, options \\ [])

View Source

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

Link to this function

list_fields(client, domain_id, input, options \\ [])

View Source

Lists all fields in a Cases domain.

Link to this function

list_layouts(client, domain_id, input, options \\ [])

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_tags_for_resource(client, arn, options \\ [])

View Source

Lists tags for a resource.

Link to this function

list_templates(client, domain_id, input, options \\ [])

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

metadata()

View Source
Link to this function

put_case_event_configuration(client, domain_id, input, options \\ [])

View Source

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

Link to this function

search_cases(client, domain_id, input, options \\ [])

View Source

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

.

Link to this function

tag_resource(client, arn, input, options \\ [])

View Source

Adds tags to a resource.

Link to this function

untag_resource(client, arn, input, options \\ [])

View Source

Untags a resource.

Link to this function

update_case(client, case_id, domain_id, input, options \\ [])

View Source

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.

Link to this function

update_field(client, domain_id, field_id, input, options \\ [])

View Source

Updates the properties of an existing field.

Link to this function

update_layout(client, domain_id, layout_id, input, options \\ [])

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_template(client, domain_id, template_id, input, options \\ [])

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.