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.
467 468 469 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 467 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.
521 522 523 524 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 521 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.
567 568 569 570 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 567 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>
648 649 650 651 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 648 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>
697 698 699 700 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 697 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.
742 743 744 745 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 742 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
823 824 825 826 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 823 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>
901 902 903 904 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 901 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.
965 966 967 968 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 965 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>
989 990 991 992 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 989 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1054 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>
1083 1084 1085 1086 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1083 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>
1112 1113 1114 1115 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1112 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.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1172 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1236 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.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1267 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.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1306 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1360 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.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1414 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.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1462 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1504 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1557 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.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1604 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.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1650 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1679 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1730 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
1777 1778 1779 1780 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1777 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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1946 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2026 def (params = {}, = {}) req = build_request(:search_related_items, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2055 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
2081 2082 2083 2084 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2081 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>
2140 2141 2142 2143 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2140 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.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2174 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.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2251 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.
2309 2310 2311 2312 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2309 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |