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
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_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 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_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_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.
409 410 411 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 409 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.
463 464 465 466 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 463 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.
509 510 511 512 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 509 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
<p>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.</p> <p>The following fields are required when creating a case:</p> <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/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>
590 591 592 593 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 590 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.
</important>
639 640 641 642 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 639 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.
684 685 686 687 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 684 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
765 766 767 768 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 765 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.</note>
840 841 842 843 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 840 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.
904 905 906 907 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 904 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Deletes a Cases domain.
<note> <p>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 <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
928 929 930 931 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 928 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.
994 995 996 997 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 994 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.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
1023 1024 1025 1026 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1023 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.
<p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>
1052 1053 1054 1055 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1052 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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1112 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.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1176 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.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1207 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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1246 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.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1300 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1354 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.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1402 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.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1444 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.
1497 1498 1499 1500 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1497 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.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1544 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.
1590 1591 1592 1593 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1590 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.
1619 1620 1621 1622 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1619 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.
1670 1671 1672 1673 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1670 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
1717 1718 1719 1720 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1717 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1886 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1962 def (params = {}, = {}) req = build_request(:search_related_items, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1991 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2017 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
<p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
2076 2077 2078 2079 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2076 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.
2110 2111 2112 2113 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2110 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.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2187 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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2245 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |