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_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
Creates a case in the specified Cases domain.
-
#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_domain(params = {}) ⇒ Struct
Deletes a domain.
-
#get_case(params = {}) ⇒ Types::GetCaseResponse
Returns information 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_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
API for adding 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
Updates the values of fields on a case.
-
#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.
365 366 367 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#batch_get_field(params = {}) ⇒ Types::BatchGetFieldResponse
Returns the description for the list of fields in the request parameters.
416 417 418 419 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 416 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.
462 463 464 465 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 462 def (params = {}, = {}) req = build_request(:batch_put_field_options, params) req.send_request() end |
#create_case(params = {}) ⇒ Types::CreateCaseResponse
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.
<ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>
532 533 534 535 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 532 def create_case(params = {}, = {}) req = build_request(:create_case, 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.
577 578 579 580 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 577 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.
622 623 624 625 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 622 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
703 704 705 706 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 703 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
.
762 763 764 765 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 762 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.
826 827 828 829 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 826 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Deletes a domain.
848 849 850 851 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 848 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, 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.
907 908 909 910 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 907 def get_case(params = {}, = {}) req = build_request(:get_case, params) req.send_request() end |
#get_case_event_configuration(params = {}) ⇒ Types::GetCaseEventConfigurationResponse
Returns the case event publishing configuration.
938 939 940 941 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 938 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.
977 978 979 980 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 977 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.
1025 1026 1027 1028 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1025 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1073 def get_template(params = {}, = {}) req = build_request(:get_template, 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.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1121 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.
1163 1164 1165 1166 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1163 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.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1216 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.
1263 1264 1265 1266 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1263 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1309 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.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1338 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1389 def list_templates(params = {}, = {}) req = build_request(:list_templates, params) req.send_request() end |
#put_case_event_configuration(params = {}) ⇒ Struct
API for adding case event publishing configuration
1430 1431 1432 1433 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1430 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.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1575 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.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1650 def (params = {}, = {}) req = build_request(:search_related_items, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1679 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1705 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_case(params = {}) ⇒ Struct
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.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1750 def update_case(params = {}, = {}) req = build_request(:update_case, params) req.send_request() end |
#update_field(params = {}) ⇒ Struct
Updates the properties of an existing field.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1784 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.
1861 1862 1863 1864 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1861 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.
1919 1920 1921 1922 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1919 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |