Packages
aws
1.0.9
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/connect_cases.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.ConnectCases do
@moduledoc """
* [Cases actions](https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html)
* [Cases data types](https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html)
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](https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) in the
*Amazon Connect Administrator Guide*.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
contact_filter() :: %{
"channel" => list(String.t() | atom()),
"contactArn" => String.t() | atom()
}
"""
@type contact_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_domain_request() :: %{}
"""
@type get_domain_request() :: %{}
@typedoc """
## Example:
delete_case_rule_request() :: %{}
"""
@type delete_case_rule_request() :: %{}
@typedoc """
## Example:
delete_domain_response() :: %{}
"""
@type delete_domain_response() :: %{}
@typedoc """
## Example:
update_case_rule_response() :: %{}
"""
@type update_case_rule_response() :: %{}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_layout_request() :: %{
optional("content") => list(),
optional("name") => String.t() | atom()
}
"""
@type update_layout_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
template_rule() :: %{
"caseRuleId" => String.t() | atom(),
"fieldId" => String.t() | atom()
}
"""
@type template_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_audit_events_response() :: %{
"auditEvents" => list(audit_event()),
"nextToken" => String.t() | atom()
}
"""
@type get_case_audit_events_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sla_content() :: %{
"slaConfiguration" => sla_configuration()
}
"""
@type sla_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_related_items_response() :: %{
optional("nextToken") => String.t() | atom(),
required("relatedItems") => list(search_related_items_response_item())
}
"""
@type search_related_items_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_fields_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_fields_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_cases_request() :: %{
optional("fields") => list(field_identifier()),
optional("filter") => list(),
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom(),
optional("searchTerm") => [String.t() | atom()],
optional("sorts") => list(sort())
}
"""
@type search_cases_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_audit_events_request() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type get_case_audit_events_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_case_rule_response() :: %{
"caseRuleArn" => String.t() | atom(),
"caseRuleId" => String.t() | atom()
}
"""
@type create_case_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_templates_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("status") => list(String.t() | atom())
}
"""
@type list_templates_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_case_request() :: %{
optional("clientToken") => [String.t() | atom()],
optional("performedBy") => list(),
required("fields") => list(field_value()),
required("templateId") => String.t() | atom()
}
"""
@type create_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_option_error() :: %{
"errorCode" => [String.t() | atom()],
"message" => [String.t() | atom()],
"value" => String.t() | atom()
}
"""
@type field_option_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_layouts_response() :: %{
optional("nextToken") => String.t() | atom(),
required("layouts") => list(layout_summary())
}
"""
@type list_layouts_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
domain_summary() :: %{
"domainArn" => String.t() | atom(),
"domainId" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type domain_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_template_request() :: %{
optional("description") => String.t() | atom(),
optional("layoutConfiguration") => layout_configuration(),
optional("requiredFields") => list(required_field()),
optional("rules") => list(template_rule()),
optional("status") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type create_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_template_response() :: %{
optional("createdTime") => non_neg_integer(),
optional("deleted") => boolean(),
optional("description") => String.t() | atom(),
optional("lastModifiedTime") => non_neg_integer(),
optional("layoutConfiguration") => layout_configuration(),
optional("requiredFields") => list(required_field()),
optional("rules") => list(template_rule()),
optional("tags") => map(),
required("name") => String.t() | atom(),
required("status") => String.t() | atom(),
required("templateArn") => String.t() | atom(),
required("templateId") => String.t() | atom()
}
"""
@type get_template_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_related_item_request() :: %{}
"""
@type delete_related_item_request() :: %{}
@typedoc """
## Example:
batch_put_field_options_request() :: %{
required("options") => list(field_option())
}
"""
@type batch_put_field_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_field_request() :: %{}
"""
@type delete_field_request() :: %{}
@typedoc """
## Example:
create_case_response() :: %{
required("caseArn") => String.t() | atom(),
required("caseId") => String.t() | atom()
}
"""
@type create_case_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
file_filter() :: %{
"fileArn" => String.t() | atom()
}
"""
@type file_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
comment_filter() :: %{}
"""
@type comment_filter() :: %{}
@typedoc """
## Example:
list_field_options_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("values") => list(String.t() | atom())
}
"""
@type list_field_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_layout_request() :: %{
required("content") => list(),
required("name") => String.t() | atom()
}
"""
@type create_layout_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_template_request() :: %{
optional("description") => String.t() | atom(),
optional("layoutConfiguration") => layout_configuration(),
optional("name") => String.t() | atom(),
optional("requiredFields") => list(required_field()),
optional("rules") => list(template_rule()),
optional("status") => String.t() | atom()
}
"""
@type update_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_cases_for_contact_response() :: %{
optional("nextToken") => String.t() | atom(),
required("cases") => list(case_summary())
}
"""
@type list_cases_for_contact_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_field_response() :: %{
required("fieldArn") => String.t() | atom(),
required("fieldId") => String.t() | atom()
}
"""
@type create_field_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_response() :: %{
optional("nextToken") => String.t() | atom(),
optional("tags") => map(),
required("fields") => list(field_value()),
required("templateId") => String.t() | atom()
}
"""
@type get_case_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
comment_content() :: %{
"body" => String.t() | atom(),
"contentType" => String.t() | atom()
}
"""
@type comment_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
required_field() :: %{
"fieldId" => String.t() | atom()
}
"""
@type required_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_rule_response() :: %{
"caseRuleArn" => String.t() | atom(),
"caseRuleId" => String.t() | atom(),
"createdTime" => non_neg_integer(),
"deleted" => boolean(),
"description" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"name" => String.t() | atom(),
"rule" => list(),
"tags" => map()
}
"""
@type get_case_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_layout_response() :: %{}
"""
@type delete_layout_response() :: %{}
@typedoc """
## Example:
search_cases_response_item() :: %{
"caseId" => String.t() | atom(),
"fields" => list(field_value()),
"tags" => map(),
"templateId" => String.t() | atom()
}
"""
@type search_cases_response_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_related_items_request() :: %{
optional("filters") => list(list()),
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type search_related_items_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_domain_request() :: %{}
"""
@type delete_domain_request() :: %{}
@typedoc """
## Example:
basic_layout() :: %{
"moreInfo" => layout_sections(),
"topPanel" => layout_sections()
}
"""
@type basic_layout() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
empty_field_value() :: %{}
"""
@type empty_field_value() :: %{}
@typedoc """
## Example:
delete_template_request() :: %{}
"""
@type delete_template_request() :: %{}
@typedoc """
## Example:
get_case_event_configuration_request() :: %{}
"""
@type get_case_event_configuration_request() :: %{}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_domain_request() :: %{
required("name") => String.t() | atom()
}
"""
@type create_domain_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_field_request() :: %{
required("fields") => list(field_identifier())
}
"""
@type batch_get_field_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_event_configuration_response() :: %{
required("eventBridge") => event_bridge_configuration()
}
"""
@type get_case_event_configuration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
audit_event_field() :: %{
"eventFieldId" => String.t() | atom(),
"newValue" => list(),
"oldValue" => list()
}
"""
@type audit_event_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_case_request() :: %{
optional("nextToken") => String.t() | atom(),
required("fields") => list(field_identifier())
}
"""
@type get_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_related_items_response_item() :: %{
"associationTime" => non_neg_integer(),
"content" => list(),
"performedBy" => list(),
"relatedItemId" => String.t() | atom(),
"tags" => map(),
"type" => String.t() | atom()
}
"""
@type search_related_items_response_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_domains_response() :: %{
optional("nextToken") => String.t() | atom(),
required("domains") => list(domain_summary())
}
"""
@type list_domains_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_case_rules_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_case_rules_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_field_response() :: %{}
"""
@type update_field_response() :: %{}
@typedoc """
## Example:
template_summary() :: %{
"name" => String.t() | atom(),
"status" => String.t() | atom(),
"templateArn" => String.t() | atom(),
"templateId" => String.t() | atom()
}
"""
@type template_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_case_rule_request() :: %{
optional("description") => String.t() | atom(),
required("name") => String.t() | atom(),
required("rule") => list()
}
"""
@type create_case_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_field_request() :: %{
optional("description") => String.t() | atom(),
required("name") => String.t() | atom(),
required("type") => String.t() | atom()
}
"""
@type create_field_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_field_response() :: %{
required("errors") => list(field_error()),
required("fields") => list(get_field_response())
}
"""
@type batch_get_field_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_case_rules_response() :: %{
"caseRules" => list(case_rule_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_case_rules_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sla_input_configuration() :: %{
"fieldId" => String.t() | atom(),
"name" => String.t() | atom(),
"targetFieldValues" => list(list()),
"targetSlaMinutes" => float(),
"type" => String.t() | atom()
}
"""
@type sla_input_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_case_rule_response() :: %{}
"""
@type delete_case_rule_response() :: %{}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
optional("tags") => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_layout_response() :: %{
required("layoutArn") => String.t() | atom(),
required("layoutId") => String.t() | atom()
}
"""
@type create_layout_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
empty_operand_value() :: %{}
"""
@type empty_operand_value() :: %{}
@typedoc """
## Example:
put_case_event_configuration_response() :: %{}
"""
@type put_case_event_configuration_response() :: %{}
@typedoc """
## Example:
list_fields_response() :: %{
optional("nextToken") => String.t() | atom(),
required("fields") => list(field_summary())
}
"""
@type list_fields_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_case_response() :: %{}
"""
@type delete_case_response() :: %{}
@typedoc """
## Example:
sort() :: %{
"fieldId" => String.t() | atom(),
"sortOrder" => String.t() | atom()
}
"""
@type sort() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contact() :: %{
"contactArn" => String.t() | atom()
}
"""
@type contact() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_related_item_response() :: %{
required("relatedItemArn") => String.t() | atom(),
required("relatedItemId") => String.t() | atom()
}
"""
@type create_related_item_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_domain_response() :: %{
optional("tags") => map(),
required("createdTime") => non_neg_integer(),
required("domainArn") => String.t() | atom(),
required("domainId") => String.t() | atom(),
required("domainStatus") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type get_domain_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_item() :: %{
"id" => String.t() | atom()
}
"""
@type field_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_error() :: %{
"errorCode" => [String.t() | atom()],
"id" => String.t() | atom(),
"message" => [String.t() | atom()]
}
"""
@type field_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_summary() :: %{
"fieldArn" => String.t() | atom(),
"fieldId" => String.t() | atom(),
"name" => String.t() | atom(),
"namespace" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type field_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_case_request() :: %{}
"""
@type delete_case_request() :: %{}
@typedoc """
## Example:
delete_related_item_response() :: %{}
"""
@type delete_related_item_response() :: %{}
@typedoc """
## Example:
list_layouts_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_layouts_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_template_response() :: %{}
"""
@type update_template_response() :: %{}
@typedoc """
## Example:
list_domains_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_domains_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => [String.t() | atom()],
"retryAfterSeconds" => [integer()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_included_data() :: %{
"caseData" => case_event_included_data(),
"relatedItemData" => related_item_event_included_data()
}
"""
@type event_included_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_case_request() :: %{
optional("performedBy") => list(),
required("fields") => list(field_value())
}
"""
@type update_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sla_filter() :: %{
"name" => String.t() | atom(),
"status" => String.t() | atom()
}
"""
@type sla_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_bridge_configuration() :: %{
"enabled" => [boolean()],
"includedData" => event_included_data()
}
"""
@type event_bridge_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_field_response() :: %{}
"""
@type delete_field_response() :: %{}
@typedoc """
## Example:
sla_configuration() :: %{
"completionTime" => non_neg_integer(),
"fieldId" => String.t() | atom(),
"name" => String.t() | atom(),
"status" => String.t() | atom(),
"targetFieldValues" => list(list()),
"targetTime" => non_neg_integer(),
"type" => String.t() | atom()
}
"""
@type sla_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_case_rule_request() :: %{
optional("description") => String.t() | atom(),
optional("name") => String.t() | atom(),
optional("rule") => list()
}
"""
@type update_case_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_layout_request() :: %{}
"""
@type get_layout_request() :: %{}
@typedoc """
## Example:
case_rule_summary() :: %{
"caseRuleArn" => String.t() | atom(),
"caseRuleId" => String.t() | atom(),
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"ruleType" => String.t() | atom()
}
"""
@type case_rule_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_case_rule_response() :: %{
"caseRules" => list(get_case_rule_response()),
"errors" => list(case_rule_error())
}
"""
@type batch_get_case_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_value() :: %{
"id" => String.t() | atom(),
"value" => list()
}
"""
@type field_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_field_request() :: %{
optional("description") => String.t() | atom(),
optional("name") => String.t() | atom()
}
"""
@type update_field_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_option() :: %{
"active" => [boolean()],
"name" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type field_option() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
layout_summary() :: %{
"layoutArn" => String.t() | atom(),
"layoutId" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type layout_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_templates_response() :: %{
optional("nextToken") => String.t() | atom(),
required("templates") => list(template_summary())
}
"""
@type list_templates_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_case_event_configuration_request() :: %{
required("eventBridge") => event_bridge_configuration()
}
"""
@type put_case_event_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
layout_sections() :: %{
"sections" => list(list())
}
"""
@type layout_sections() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_template_request() :: %{}
"""
@type get_template_request() :: %{}
@typedoc """
## Example:
validation_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_domain_response() :: %{
required("domainArn") => String.t() | atom(),
required("domainId") => String.t() | atom(),
required("domainStatus") => String.t() | atom()
}
"""
@type create_domain_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_layout_response() :: %{
optional("createdTime") => non_neg_integer(),
optional("deleted") => boolean(),
optional("lastModifiedTime") => non_neg_integer(),
optional("tags") => map(),
required("content") => list(),
required("layoutArn") => String.t() | atom(),
required("layoutId") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type get_layout_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_cases_response() :: %{
optional("nextToken") => String.t() | atom(),
required("cases") => list(search_cases_response_item())
}
"""
@type search_cases_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_put_field_options_response() :: %{
optional("errors") => list(field_option_error())
}
"""
@type batch_put_field_options_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_case_response() :: %{}
"""
@type update_case_response() :: %{}
@typedoc """
## Example:
case_rule_error() :: %{
"errorCode" => [String.t() | atom()],
"id" => String.t() | atom(),
"message" => [String.t() | atom()]
}
"""
@type case_rule_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_template_response() :: %{
required("templateArn") => String.t() | atom(),
required("templateId") => String.t() | atom()
}
"""
@type create_template_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_layout_response() :: %{}
"""
@type update_layout_response() :: %{}
@typedoc """
## Example:
delete_template_response() :: %{}
"""
@type delete_template_response() :: %{}
@typedoc """
## Example:
field_identifier() :: %{
"id" => String.t() | atom()
}
"""
@type field_identifier() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
file_content() :: %{
"fileArn" => String.t() | atom()
}
"""
@type file_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
boolean_operands() :: %{
"operandOne" => list(),
"operandTwo" => list(),
"result" => [boolean()]
}
"""
@type boolean_operands() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_layout_request() :: %{}
"""
@type delete_layout_request() :: %{}
@typedoc """
## Example:
required_case_rule() :: %{
"conditions" => list(list()),
"defaultValue" => [boolean()]
}
"""
@type required_case_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_field_options_response() :: %{
optional("nextToken") => String.t() | atom(),
required("options") => list(field_option())
}
"""
@type list_field_options_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
case_rule_identifier() :: %{
"id" => String.t() | atom()
}
"""
@type case_rule_identifier() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_cases_for_contact_request() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom(),
required("contactArn") => String.t() | atom()
}
"""
@type list_cases_for_contact_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_related_item_request() :: %{
optional("performedBy") => list(),
required("content") => list(),
required("type") => String.t() | atom()
}
"""
@type create_related_item_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_field_response() :: %{
"createdTime" => non_neg_integer(),
"deleted" => boolean(),
"description" => String.t() | atom(),
"fieldArn" => String.t() | atom(),
"fieldId" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"name" => String.t() | atom(),
"namespace" => String.t() | atom(),
"tags" => map(),
"type" => String.t() | atom()
}
"""
@type get_field_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
case_summary() :: %{
"caseId" => String.t() | atom(),
"templateId" => String.t() | atom()
}
"""
@type case_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_group() :: %{
"fields" => list(field_item()),
"name" => [String.t() | atom()]
}
"""
@type field_group() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
audit_event() :: %{
"eventId" => String.t() | atom(),
"fields" => list(audit_event_field()),
"performedBy" => audit_event_performed_by(),
"performedTime" => non_neg_integer(),
"relatedItemType" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type audit_event() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
case_event_included_data() :: %{
"fields" => list(field_identifier())
}
"""
@type case_event_included_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
layout_configuration() :: %{
"defaultLayout" => String.t() | atom()
}
"""
@type layout_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
related_item_event_included_data() :: %{
"includeContent" => [boolean()]
}
"""
@type related_item_event_included_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contact_content() :: %{
"channel" => String.t() | atom(),
"connectedToSystemTime" => non_neg_integer(),
"contactArn" => String.t() | atom()
}
"""
@type contact_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
audit_event_performed_by() :: %{
"iamPrincipalArn" => String.t() | atom(),
"user" => list()
}
"""
@type audit_event_performed_by() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_case_rule_request() :: %{
required("caseRules") => list(case_rule_identifier())
}
"""
@type batch_get_case_rule_request() :: %{(String.t() | atom()) => any()}
@type batch_get_case_rule_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type batch_get_field_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type batch_put_field_options_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type create_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_case_rule_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_domain_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_field_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_layout_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_related_item_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type create_template_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_case_rule_errors() ::
throttling_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_domain_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_field_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_layout_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_related_item_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_template_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type get_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_case_audit_events_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_case_event_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_domain_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_layout_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_template_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_case_rules_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_cases_for_contact_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_domains_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_field_options_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_fields_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_layouts_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_templates_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type put_case_event_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type search_cases_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type search_related_items_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type tag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type untag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_case_rule_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_field_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_layout_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_template_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
def metadata do
%{
api_version: "2022-10-03",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "cases",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "ConnectCases",
signature_version: "v4",
signing_name: "cases",
target_prefix: nil
}
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).
"""
@spec batch_get_case_rule(map(), String.t() | atom(), batch_get_case_rule_request(), list()) ::
{:ok, batch_get_case_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_get_case_rule_errors()}
def batch_get_case_rule(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/rules-batch"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the description for the list of fields in the request parameters.
"""
@spec batch_get_field(map(), String.t() | atom(), batch_get_field_request(), list()) ::
{:ok, batch_get_field_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_get_field_errors()}
def batch_get_field(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/fields-batch"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates and updates a set of field options for a single select field in a Cases
domain.
"""
@spec batch_put_field_options(
map(),
String.t() | atom(),
String.t() | atom(),
batch_put_field_options_request(),
list()
) ::
{:ok, batch_put_field_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_put_field_options_errors()}
def batch_put_field_options(%Client{} = client, domain_id, field_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/fields/#{AWS.Util.encode_uri(field_id)}/options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
If you provide a value for `PerformedBy.UserArn` you must also have
[connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html)
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`
"""
@spec create_case(map(), String.t() | atom(), create_case_request(), list()) ::
{:ok, create_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_case_errors()}
def create_case(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/cases"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).
"""
@spec create_case_rule(map(), String.t() | atom(), create_case_rule_request(), list()) ::
{:ok, create_case_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_case_rule_errors()}
def create_case_rule(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/case-rules"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases
domain. For more information, see [Onboard to
Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam).
"""
@spec create_domain(map(), create_domain_request(), list()) ::
{:ok, create_domain_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_domain_errors()}
def create_domain(%Client{} = client, input, options \\ []) do
url_path = "/domains"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_field(map(), String.t() | atom(), create_field_request(), list()) ::
{:ok, create_field_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_field_errors()}
def create_field(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/fields"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_layout(map(), String.t() | atom(), create_layout_request(), list()) ::
{:ok, create_layout_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_layout_errors()}
def create_layout(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/layouts"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html)
permission on the ARN of the user that you provide.
The `type` field is reserved for internal use only.
"""
@spec create_related_item(
map(),
String.t() | atom(),
String.t() | atom(),
create_related_item_request(),
list()
) ::
{:ok, create_related_item_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_related_item_errors()}
def create_related_item(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}/related-items/"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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:
*
[DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) *
[GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html)
*
[ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) *
[UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html)
"""
@spec create_template(map(), String.t() | atom(), create_template_request(), list()) ::
{:ok, create_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_template_errors()}
def create_template(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/templates"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
The DeleteCase API permanently deletes a case and all its associated resources
from the cases data store.
After a successful deletion, you cannot:
* Retrieve related items
* Access audit history
* Perform any operations that require the CaseID
This action is irreversible. Once you delete a case, you cannot recover its
data.
"""
@spec delete_case(
map(),
String.t() | atom(),
String.t() | atom(),
delete_case_request(),
list()
) ::
{:ok, delete_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_case_errors()}
def delete_case(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).
"""
@spec delete_case_rule(
map(),
String.t() | atom(),
String.t() | atom(),
delete_case_rule_request(),
list()
) ::
{:ok, delete_case_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_case_rule_errors()}
def delete_case_rule(%Client{} = client, case_rule_id, domain_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/case-rules/#{AWS.Util.encode_uri(case_rule_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html).
"""
@spec delete_domain(map(), String.t() | atom(), delete_domain_request(), list()) ::
{:ok, delete_domain_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_domain_errors()}
def delete_domain(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_field(
map(),
String.t() | atom(),
String.t() | atom(),
delete_field_request(),
list()
) ::
{:ok, delete_field_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_field_errors()}
def delete_field(%Client{} = client, domain_id, field_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/fields/#{AWS.Util.encode_uri(field_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_layout(
map(),
String.t() | atom(),
String.t() | atom(),
delete_layout_request(),
list()
) ::
{:ok, delete_layout_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_layout_errors()}
def delete_layout(%Client{} = client, domain_id, layout_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/layouts/#{AWS.Util.encode_uri(layout_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the related item resource under a case.
This API cannot be used on a FILE type related attachment. To delete this type
of file, use the
[DeleteAttachedFile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html)
API
"""
@spec delete_related_item(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
delete_related_item_request(),
list()
) ::
{:ok, delete_related_item_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_related_item_errors()}
def delete_related_item(
%Client{} = client,
case_id,
domain_id,
related_item_id,
input,
options \\ []
) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}/related-items/#{AWS.Util.encode_uri(related_item_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_template(
map(),
String.t() | atom(),
String.t() | atom(),
delete_template_request(),
list()
) ::
{:ok, delete_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_template_errors()}
def delete_template(%Client{} = client, domain_id, template_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/templates/#{AWS.Util.encode_uri(template_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns information about a specific case if it exists.
"""
@spec get_case(map(), String.t() | atom(), String.t() | atom(), get_case_request(), list()) ::
{:ok, get_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_case_errors()}
def get_case(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the audit history about a specific case if it exists.
"""
@spec get_case_audit_events(
map(),
String.t() | atom(),
String.t() | atom(),
get_case_audit_events_request(),
list()
) ::
{:ok, get_case_audit_events_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_case_audit_events_errors()}
def get_case_audit_events(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}/audit-history"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the case event publishing configuration.
"""
@spec get_case_event_configuration(
map(),
String.t() | atom(),
get_case_event_configuration_request(),
list()
) ::
{:ok, get_case_event_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_case_event_configuration_errors()}
def get_case_event_configuration(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/case-event-configuration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns information about a specific domain if it exists.
"""
@spec get_domain(map(), String.t() | atom(), get_domain_request(), list()) ::
{:ok, get_domain_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_domain_errors()}
def get_domain(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the details for the requested layout.
"""
@spec get_layout(map(), String.t() | atom(), String.t() | atom(), get_layout_request(), list()) ::
{:ok, get_layout_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_layout_errors()}
def get_layout(%Client{} = client, domain_id, layout_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/layouts/#{AWS.Util.encode_uri(layout_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the details for the requested template.
Other template APIs are:
*
[CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) *
[DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html)
*
[ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) *
[UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html)
"""
@spec get_template(
map(),
String.t() | atom(),
String.t() | atom(),
get_template_request(),
list()
) ::
{:ok, get_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_template_errors()}
def get_template(%Client{} = client, domain_id, template_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/templates/#{AWS.Util.encode_uri(template_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).
"""
@spec list_case_rules(map(), String.t() | atom(), list_case_rules_request(), list()) ::
{:ok, list_case_rules_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_case_rules_errors()}
def list_case_rules(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/rules-list/"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists cases for a given contact.
"""
@spec list_cases_for_contact(
map(),
String.t() | atom(),
list_cases_for_contact_request(),
list()
) ::
{:ok, list_cases_for_contact_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_cases_for_contact_errors()}
def list_cases_for_contact(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/list-cases-for-contact"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all cases domains in the Amazon Web Services account.
Each list item is a condensed summary object of the domain.
"""
@spec list_domains(map(), list_domains_request(), list()) ::
{:ok, list_domains_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_domains_errors()}
def list_domains(%Client{} = client, input, options \\ []) do
url_path = "/domains-list"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all of the field options for a field identifier in the domain.
"""
@spec list_field_options(
map(),
String.t() | atom(),
String.t() | atom(),
list_field_options_request(),
list()
) ::
{:ok, list_field_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_field_options_errors()}
def list_field_options(%Client{} = client, domain_id, field_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/fields/#{AWS.Util.encode_uri(field_id)}/options-list"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"},
{"values", "values"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all fields in a Cases domain.
"""
@spec list_fields(map(), String.t() | atom(), list_fields_request(), list()) ::
{:ok, list_fields_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_fields_errors()}
def list_fields(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/fields-list"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all layouts in the given cases domain.
Each list item is a condensed summary object of the layout.
"""
@spec list_layouts(map(), String.t() | atom(), list_layouts_request(), list()) ::
{:ok, list_layouts_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_layouts_errors()}
def list_layouts(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/layouts-list"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists tags for a resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all of the templates in a Cases domain.
Each list item is a condensed summary object of the template.
Other template APIs are:
*
[CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) *
[DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html)
*
[GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) *
[UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html)
"""
@spec list_templates(map(), String.t() | atom(), list_templates_request(), list()) ::
{:ok, list_templates_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_templates_errors()}
def list_templates(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/templates-list"
headers = []
custom_headers = []
{query_params, input} =
[
{"maxResults", "maxResults"},
{"nextToken", "nextToken"},
{"status", "status"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds case event publishing configuration.
For a complete list of fields you can add to the event message, see [Create case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html)
in the *Amazon Connect Administrator Guide*
"""
@spec put_case_event_configuration(
map(),
String.t() | atom(),
put_case_event_configuration_request(),
list()
) ::
{:ok, put_case_event_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_case_event_configuration_errors()}
def put_case_event_configuration(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/case-event-configuration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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`.
"""
@spec search_cases(map(), String.t() | atom(), search_cases_request(), list()) ::
{:ok, search_cases_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_cases_errors()}
def search_cases(%Client{} = client, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/cases-search"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a
case.
"""
@spec search_related_items(
map(),
String.t() | atom(),
String.t() | atom(),
search_related_items_request(),
list()
) ::
{:ok, search_related_items_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_related_items_errors()}
def search_related_items(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}/related-items-search"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds tags to a resource.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Untags a resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
If you provide a value for `PerformedBy.UserArn` you must also have
[connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html)
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.
"""
@spec update_case(
map(),
String.t() | atom(),
String.t() | atom(),
update_case_request(),
list()
) ::
{:ok, update_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_case_errors()}
def update_case(%Client{} = client, case_id, domain_id, input, options \\ []) do
url_path = "/domains/#{AWS.Util.encode_uri(domain_id)}/cases/#{AWS.Util.encode_uri(case_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).
"""
@spec update_case_rule(
map(),
String.t() | atom(),
String.t() | atom(),
update_case_rule_request(),
list()
) ::
{:ok, update_case_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_case_rule_errors()}
def update_case_rule(%Client{} = client, case_rule_id, domain_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/case-rules/#{AWS.Util.encode_uri(case_rule_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the properties of an existing field.
"""
@spec update_field(
map(),
String.t() | atom(),
String.t() | atom(),
update_field_request(),
list()
) ::
{:ok, update_field_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_field_errors()}
def update_field(%Client{} = client, domain_id, field_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/fields/#{AWS.Util.encode_uri(field_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec update_layout(
map(),
String.t() | atom(),
String.t() | atom(),
update_layout_request(),
list()
) ::
{:ok, update_layout_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_layout_errors()}
def update_layout(%Client{} = client, domain_id, layout_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/layouts/#{AWS.Util.encode_uri(layout_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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:
*
[CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) *
[DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html)
*
[GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) *
[ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html)
"""
@spec update_template(
map(),
String.t() | atom(),
String.t() | atom(),
update_template_request(),
list()
) ::
{:ok, update_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_template_errors()}
def update_template(%Client{} = client, domain_id, template_id, input, options \\ []) do
url_path =
"/domains/#{AWS.Util.encode_uri(domain_id)}/templates/#{AWS.Util.encode_uri(template_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end