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.
-
#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.
385 386 387 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 385 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.
436 437 438 439 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 436 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.
482 483 484 485 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 482 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>
563 564 565 566 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 563 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>
612 613 614 615 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 612 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.
657 658 659 660 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 657 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
738 739 740 741 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 738 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>
813 814 815 816 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 813 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.
877 878 879 880 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 877 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>
901 902 903 904 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 901 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.
961 962 963 964 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 961 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.
1025 1026 1027 1028 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1025 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.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1056 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.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1095 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.
1143 1144 1145 1146 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1143 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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1191 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.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1239 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.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1281 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.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1334 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.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1381 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.
1427 1428 1429 1430 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1427 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.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1456 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.
1507 1508 1509 1510 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1507 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
1554 1555 1556 1557 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1554 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.
1723 1724 1725 1726 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1723 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.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1799 def (params = {}, = {}) req = build_request(:search_related_items, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1828 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1854 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>
1913 1914 1915 1916 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1913 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.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 1947 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.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2024 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.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/client.rb', line 2082 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |