Class: Aws::ConnectCases::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConnectCases::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb
Overview
An API client for ConnectCases. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ConnectCases::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_case_rule(params = {}) ⇒ Types::BatchGetCaseRuleResponse
Gets a batch of case rules.
-
#batch_get_field(params = {}) ⇒ Types::BatchGetFieldResponse
Returns the description for the list of fields in the request parameters.
-
#batch_put_field_options(params = {}) ⇒ Types::BatchPutFieldOptionsResponse
Creates and updates a set of field options for a single select field in a Cases domain.
-
#create_case(params = {}) ⇒ Types::CreateCaseResponse
If you provide a value for PerformedBy.UserArn
you must also have [connect:DescribeUser][1] permission on the User ARN resource that you provide. -
#create_case_rule(params = {}) ⇒ Types::CreateCaseRuleResponse
Creates a new case rule.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
-
#create_field(params = {}) ⇒ Types::CreateFieldResponse
Creates a field in the Cases domain.
-
#create_layout(params = {}) ⇒ Types::CreateLayoutResponse
Creates a layout in the Cases domain.
-
#create_related_item(params = {}) ⇒ Types::CreateRelatedItemResponse
Creates a related item (comments, tasks, and contacts) and associates it with a case.
-
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template in the Cases domain.
-
#delete_case_rule(params = {}) ⇒ Struct
Deletes a case rule.
-
#delete_domain(params = {}) ⇒ Struct
Deletes a Cases domain.
-
#delete_field(params = {}) ⇒ Struct
Deletes a field from a cases template.
-
#delete_layout(params = {}) ⇒ Struct
Deletes a layout from a cases template.
-
#delete_template(params = {}) ⇒ Struct
Deletes a cases template.
-
#get_case(params = {}) ⇒ Types::GetCaseResponse
Returns information about a specific case if it exists.
-
#get_case_audit_events(params = {}) ⇒ Types::GetCaseAuditEventsResponse
Returns the audit history about a specific case if it exists.
-
#get_case_event_configuration(params = {}) ⇒ Types::GetCaseEventConfigurationResponse
Returns the case event publishing configuration.
-
#get_domain(params = {}) ⇒ Types::GetDomainResponse
Returns information about a specific domain if it exists.
-
#get_layout(params = {}) ⇒ Types::GetLayoutResponse
Returns the details for the requested layout.
-
#get_template(params = {}) ⇒ Types::GetTemplateResponse
Returns the details for the requested template.
-
#list_case_rules(params = {}) ⇒ Types::ListCaseRulesResponse
Lists all case rules in a Cases domain.
-
#list_cases_for_contact(params = {}) ⇒ Types::ListCasesForContactResponse
Lists cases for a given contact.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists all cases domains in the Amazon Web Services account.
-
#list_field_options(params = {}) ⇒ Types::ListFieldOptionsResponse
Lists all of the field options for a field identifier in the domain.
-
#list_fields(params = {}) ⇒ Types::ListFieldsResponse
Lists all fields in a Cases domain.
-
#list_layouts(params = {}) ⇒ Types::ListLayoutsResponse
Lists all layouts in the given cases domain.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all of the templates in a Cases domain.
-
#put_case_event_configuration(params = {}) ⇒ Struct
Adds case event publishing configuration.
-
#search_cases(params = {}) ⇒ Types::SearchCasesResponse
Searches for cases within their associated Cases domain.
-
#search_related_items(params = {}) ⇒ Types::SearchRelatedItemsResponse
Searches for related items that are associated with a case.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
-
#update_case(params = {}) ⇒ Struct
If you provide a value for PerformedBy.UserArn
you must also have [connect:DescribeUser][1] permission on the User ARN resource that you provide. -
#update_case_rule(params = {}) ⇒ Struct
Updates a case rule.
-
#update_field(params = {}) ⇒ Struct
Updates the properties of an existing field.
-
#update_layout(params = {}) ⇒ Struct
Updates the attributes of an existing layout.
-
#update_template(params = {}) ⇒ Struct
Updates the attributes of an existing template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
466 467 468 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#batch_get_case_rule(params = {}) ⇒ Types::BatchGetCaseRuleResponse
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.
536 537 538 539 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 536 def batch_get_case_rule(params = {}, = {}) req = build_request(:batch_get_case_rule, params) req.send_request() end |
#batch_get_field(params = {}) ⇒ Types::BatchGetFieldResponse
Returns the description for the list of fields in the request parameters.
589 590 591 592 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 589 def batch_get_field(params = {}, = {}) req = build_request(:batch_get_field, params) req.send_request() end |
#batch_put_field_options(params = {}) ⇒ Types::BatchPutFieldOptionsResponse
Creates and updates a set of field options for a single select field in a Cases domain.
635 636 637 638 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 635 def (params = {}, = {}) req = build_request(:batch_put_field_options, params) req.send_request() end |
#create_case(params = {}) ⇒ Types::CreateCaseResponse
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
727 728 729 730 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 727 def create_case(params = {}, = {}) req = build_request(:create_case, params) req.send_request() end |
#create_case_rule(params = {}) ⇒ Types::CreateCaseRuleResponse
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.
810 811 812 813 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 810 def create_case_rule(params = {}, = {}) req = build_request(:create_case_rule, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
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.
855 856 857 858 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 855 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_field(params = {}) ⇒ Types::CreateFieldResponse
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.
900 901 902 903 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 900 def create_field(params = {}, = {}) req = build_request(:create_field, params) req.send_request() end |
#create_layout(params = {}) ⇒ Types::CreateLayoutResponse
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
981 982 983 984 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 981 def create_layout(params = {}, = {}) req = build_request(:create_layout, params) req.send_request() end |
#create_related_item(params = {}) ⇒ Types::CreateRelatedItemResponse
Creates a related item (comments, tasks, and contacts) and associates it with a case.
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 permission on the ARN of the user that you provide.The
type
field is reserved for internal use only.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1078 def (params = {}, = {}) req = build_request(:create_related_item, params) req.send_request() end |
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
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:
1173 1174 1175 1176 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1173 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#delete_case_rule(params = {}) ⇒ Struct
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.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1206 def delete_case_rule(params = {}, = {}) req = build_request(:delete_case_rule, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Deletes a Cases domain.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1239 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_field(params = {}) ⇒ Struct
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 aValidationException
.Deleted fields are not included in the
ListFields
response.Calling
CreateCase
with a deleted field throws aValidationException
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 aValidationException
if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (usingemptyValue: {}
) 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 asearchTerm
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 aValidationException
.Calling
GetCaseEventConfiguration
does not return field IDs for deleted fields.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1304 def delete_field(params = {}, = {}) req = build_request(:delete_field, params) req.send_request() end |
#delete_layout(params = {}) ⇒ Struct
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 aValidationException
.Deleted layouts are not included in the
ListLayouts
response.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1340 def delete_layout(params = {}, = {}) req = build_request(:delete_layout, params) req.send_request() end |
#delete_template(params = {}) ⇒ Struct
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.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1377 def delete_template(params = {}, = {}) req = build_request(:delete_template, params) req.send_request() end |
#get_case(params = {}) ⇒ Types::GetCaseResponse
Returns information about a specific case if it exists.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1437 def get_case(params = {}, = {}) req = build_request(:get_case, params) req.send_request() end |
#get_case_audit_events(params = {}) ⇒ Types::GetCaseAuditEventsResponse
Returns the audit history about a specific case if it exists.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1502 1503 1504 1505 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1502 def get_case_audit_events(params = {}, = {}) req = build_request(:get_case_audit_events, params) req.send_request() end |
#get_case_event_configuration(params = {}) ⇒ Types::GetCaseEventConfigurationResponse
Returns the case event publishing configuration.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1533 def get_case_event_configuration(params = {}, = {}) req = build_request(:get_case_event_configuration, params) req.send_request() end |
#get_domain(params = {}) ⇒ Types::GetDomainResponse
Returns information about a specific domain if it exists.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1572 def get_domain(params = {}, = {}) req = build_request(:get_domain, params) req.send_request() end |
#get_layout(params = {}) ⇒ Types::GetLayoutResponse
Returns the details for the requested layout.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1626 def get_layout(params = {}, = {}) req = build_request(:get_layout, params) req.send_request() end |
#get_template(params = {}) ⇒ Types::GetTemplateResponse
Returns the details for the requested template. Other template APIs are:
1700 1701 1702 1703 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1700 def get_template(params = {}, = {}) req = build_request(:get_template, params) req.send_request() end |
#list_case_rules(params = {}) ⇒ Types::ListCaseRulesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1754 1755 1756 1757 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1754 def list_case_rules(params = {}, = {}) req = build_request(:list_case_rules, params) req.send_request() end |
#list_cases_for_contact(params = {}) ⇒ Types::ListCasesForContactResponse
Lists cases for a given contact.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1802 def list_cases_for_contact(params = {}, = {}) req = build_request(:list_cases_for_contact, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1844 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_field_options(params = {}) ⇒ Types::ListFieldOptionsResponse
Lists all of the field options for a field identifier in the domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1897 1898 1899 1900 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1897 def (params = {}, = {}) req = build_request(:list_field_options, params) req.send_request() end |
#list_fields(params = {}) ⇒ Types::ListFieldsResponse
Lists all fields in a Cases domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1944 def list_fields(params = {}, = {}) req = build_request(:list_fields, params) req.send_request() end |
#list_layouts(params = {}) ⇒ Types::ListLayoutsResponse
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1990 1991 1992 1993 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1990 def list_layouts(params = {}, = {}) req = build_request(:list_layouts, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2019 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
Other template APIs are:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2087 2088 2089 2090 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2087 def list_templates(params = {}, = {}) req = build_request(:list_templates, params) req.send_request() end |
#put_case_event_configuration(params = {}) ⇒ Struct
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
2134 2135 2136 2137 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2134 def put_case_event_configuration(params = {}, = {}) req = build_request(:put_case_event_configuration, params) req.send_request() end |
#search_cases(params = {}) ⇒ Types::SearchCasesResponse
Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2303 2304 2305 2306 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2303 def search_cases(params = {}, = {}) req = build_request(:search_cases, params) req.send_request() end |
#search_related_items(params = {}) ⇒ Types::SearchRelatedItemsResponse
Searches for related items that are associated with a case.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2399 def (params = {}, = {}) req = build_request(:search_related_items, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
2428 2429 2430 2431 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2428 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
2454 2455 2456 2457 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2454 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_case(params = {}) ⇒ Struct
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.
2519 2520 2521 2522 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2519 def update_case(params = {}, = {}) req = build_request(:update_case, params) req.send_request() end |
#update_case_rule(params = {}) ⇒ Struct
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.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2598 def update_case_rule(params = {}, = {}) req = build_request(:update_case_rule, params) req.send_request() end |
#update_field(params = {}) ⇒ Struct
Updates the properties of an existing field.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2632 def update_field(params = {}, = {}) req = build_request(:update_field, params) req.send_request() end |
#update_layout(params = {}) ⇒ Struct
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.
2709 2710 2711 2712 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2709 def update_layout(params = {}, = {}) req = build_request(:update_layout, params) req.send_request() end |
#update_template(params = {}) ⇒ Struct
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:
2798 2799 2800 2801 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2798 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |