@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectCasesAsyncClient extends AmazonConnectCasesClient implements AmazonConnectCasesAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbatchGetField, batchPutFieldOptions, builder, createCase, createDomain, createField, createLayout, createRelatedItem, createTemplate, deleteDomain, deleteField, deleteLayout, deleteTemplate, getCachedResponseMetadata, getCase, getCaseAuditEvents, getCaseEventConfiguration, getDomain, getLayout, getTemplate, listCasesForContact, listDomains, listFieldOptions, listFields, listLayouts, listTagsForResource, listTemplates, putCaseEventConfiguration, searchCases, searchRelatedItems, tagResource, untagResource, updateCase, updateField, updateLayout, updateTemplateaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbatchGetField, batchPutFieldOptions, createCase, createDomain, createField, createLayout, createRelatedItem, createTemplate, deleteDomain, deleteField, deleteLayout, deleteTemplate, getCachedResponseMetadata, getCase, getCaseAuditEvents, getCaseEventConfiguration, getDomain, getLayout, getTemplate, listCasesForContact, listDomains, listFieldOptions, listFields, listLayouts, listTagsForResource, listTemplates, putCaseEventConfiguration, searchCases, searchRelatedItems, tagResource, untagResource, updateCase, updateField, updateLayout, updateTemplatepublic static AmazonConnectCasesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchGetFieldResult> batchGetFieldAsync(BatchGetFieldRequest request)
AmazonConnectCasesAsyncReturns the description for the list of fields in the request parameters.
batchGetFieldAsync in interface AmazonConnectCasesAsyncpublic Future<BatchGetFieldResult> batchGetFieldAsync(BatchGetFieldRequest request, AsyncHandler<BatchGetFieldRequest,BatchGetFieldResult> asyncHandler)
AmazonConnectCasesAsyncReturns the description for the list of fields in the request parameters.
batchGetFieldAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchPutFieldOptionsResult> batchPutFieldOptionsAsync(BatchPutFieldOptionsRequest request)
AmazonConnectCasesAsyncCreates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptionsAsync in interface AmazonConnectCasesAsyncpublic Future<BatchPutFieldOptionsResult> batchPutFieldOptionsAsync(BatchPutFieldOptionsRequest request, AsyncHandler<BatchPutFieldOptionsRequest,BatchPutFieldOptionsResult> asyncHandler)
AmazonConnectCasesAsyncCreates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptionsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateCaseResult> createCaseAsync(CreateCaseRequest request)
AmazonConnectCasesAsync
If you provide a value for 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>
createCaseAsync in interface AmazonConnectCasesAsyncpublic Future<CreateCaseResult> createCaseAsync(CreateCaseRequest request, AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
AmazonConnectCasesAsync
If you provide a value for 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>
createCaseAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request)
AmazonConnectCasesAsyncCreates 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.
</important>
createDomainAsync in interface AmazonConnectCasesAsyncpublic Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
AmazonConnectCasesAsyncCreates 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.
</important>
createDomainAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFieldResult> createFieldAsync(CreateFieldRequest request)
AmazonConnectCasesAsyncCreates 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.
createFieldAsync in interface AmazonConnectCasesAsyncpublic Future<CreateFieldResult> createFieldAsync(CreateFieldRequest request, AsyncHandler<CreateFieldRequest,CreateFieldResult> asyncHandler)
AmazonConnectCasesAsyncCreates 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.
createFieldAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLayoutResult> createLayoutAsync(CreateLayoutRequest request)
AmazonConnectCasesAsyncCreates 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
Title and Status fields cannot be part of layouts since they are not configurable.
createLayoutAsync in interface AmazonConnectCasesAsyncpublic Future<CreateLayoutResult> createLayoutAsync(CreateLayoutRequest request, AsyncHandler<CreateLayoutRequest,CreateLayoutResult> asyncHandler)
AmazonConnectCasesAsyncCreates 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
Title and Status fields cannot be part of layouts since they are not configurable.
createLayoutAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRelatedItemResult> createRelatedItemAsync(CreateRelatedItemRequest request)
AmazonConnectCasesAsyncCreates a related item (comments, tasks, and contacts) and associates it with a case.
A Related Item is a resource that is associated with a case. It may or may not have an external identifier
linking it to an external resource (for example, a 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>
createRelatedItemAsync in interface AmazonConnectCasesAsyncpublic Future<CreateRelatedItemResult> createRelatedItemAsync(CreateRelatedItemRequest request, AsyncHandler<CreateRelatedItemRequest,CreateRelatedItemResult> asyncHandler)
AmazonConnectCasesAsyncCreates a related item (comments, tasks, and contacts) and associates it with a case.
A Related Item is a resource that is associated with a case. It may or may not have an external identifier
linking it to an external resource (for example, a 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>
createRelatedItemAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request)
AmazonConnectCasesAsyncCreates 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.
createTemplateAsync in interface AmazonConnectCasesAsyncpublic Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
AmazonConnectCasesAsyncCreates 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.
createTemplateAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request)
AmazonConnectCasesAsyncDeletes 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>
deleteDomainAsync in interface AmazonConnectCasesAsyncpublic Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
AmazonConnectCasesAsyncDeletes 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>
deleteDomainAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFieldResult> deleteFieldAsync(DeleteFieldRequest request)
AmazonConnectCasesAsyncDeletes 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 a
ValidationException.
Deleted fields are not included in the ListFields response.
Calling CreateCase with a deleted field throws a ValidationException 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 a ValidationException if the case
does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove
(using emptyValue: {}) 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 a searchTerm 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 a ValidationException.
Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
deleteFieldAsync in interface AmazonConnectCasesAsyncpublic Future<DeleteFieldResult> deleteFieldAsync(DeleteFieldRequest request, AsyncHandler<DeleteFieldRequest,DeleteFieldResult> asyncHandler)
AmazonConnectCasesAsyncDeletes 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 a
ValidationException.
Deleted fields are not included in the ListFields response.
Calling CreateCase with a deleted field throws a ValidationException 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 a ValidationException if the case
does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove
(using emptyValue: {}) 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 a searchTerm 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 a ValidationException.
Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
deleteFieldAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLayoutResult> deleteLayoutAsync(DeleteLayoutRequest request)
AmazonConnectCasesAsyncDeletes 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>
deleteLayoutAsync in interface AmazonConnectCasesAsyncpublic Future<DeleteLayoutResult> deleteLayoutAsync(DeleteLayoutRequest request, AsyncHandler<DeleteLayoutRequest,DeleteLayoutResult> asyncHandler)
AmazonConnectCasesAsyncDeletes 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>
deleteLayoutAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request)
AmazonConnectCasesAsyncDeletes 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>
deleteTemplateAsync in interface AmazonConnectCasesAsyncpublic Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
AmazonConnectCasesAsyncDeletes 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>
deleteTemplateAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCaseResult> getCaseAsync(GetCaseRequest request)
AmazonConnectCasesAsyncReturns information about a specific case if it exists.
getCaseAsync in interface AmazonConnectCasesAsyncpublic Future<GetCaseResult> getCaseAsync(GetCaseRequest request, AsyncHandler<GetCaseRequest,GetCaseResult> asyncHandler)
AmazonConnectCasesAsyncReturns information about a specific case if it exists.
getCaseAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCaseAuditEventsResult> getCaseAuditEventsAsync(GetCaseAuditEventsRequest request)
AmazonConnectCasesAsyncReturns the audit history about a specific case if it exists.
getCaseAuditEventsAsync in interface AmazonConnectCasesAsyncpublic Future<GetCaseAuditEventsResult> getCaseAuditEventsAsync(GetCaseAuditEventsRequest request, AsyncHandler<GetCaseAuditEventsRequest,GetCaseAuditEventsResult> asyncHandler)
AmazonConnectCasesAsyncReturns the audit history about a specific case if it exists.
getCaseAuditEventsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCaseEventConfigurationResult> getCaseEventConfigurationAsync(GetCaseEventConfigurationRequest request)
AmazonConnectCasesAsyncReturns the case event publishing configuration.
getCaseEventConfigurationAsync in interface AmazonConnectCasesAsyncpublic Future<GetCaseEventConfigurationResult> getCaseEventConfigurationAsync(GetCaseEventConfigurationRequest request, AsyncHandler<GetCaseEventConfigurationRequest,GetCaseEventConfigurationResult> asyncHandler)
AmazonConnectCasesAsyncReturns the case event publishing configuration.
getCaseEventConfigurationAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDomainResult> getDomainAsync(GetDomainRequest request)
AmazonConnectCasesAsyncReturns information about a specific domain if it exists.
getDomainAsync in interface AmazonConnectCasesAsyncpublic Future<GetDomainResult> getDomainAsync(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
AmazonConnectCasesAsyncReturns information about a specific domain if it exists.
getDomainAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLayoutResult> getLayoutAsync(GetLayoutRequest request)
AmazonConnectCasesAsyncReturns the details for the requested layout.
getLayoutAsync in interface AmazonConnectCasesAsyncpublic Future<GetLayoutResult> getLayoutAsync(GetLayoutRequest request, AsyncHandler<GetLayoutRequest,GetLayoutResult> asyncHandler)
AmazonConnectCasesAsyncReturns the details for the requested layout.
getLayoutAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest request)
AmazonConnectCasesAsyncReturns the details for the requested template.
getTemplateAsync in interface AmazonConnectCasesAsyncpublic Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest request, AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
AmazonConnectCasesAsyncReturns the details for the requested template.
getTemplateAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListCasesForContactResult> listCasesForContactAsync(ListCasesForContactRequest request)
AmazonConnectCasesAsyncLists cases for a given contact.
listCasesForContactAsync in interface AmazonConnectCasesAsyncpublic Future<ListCasesForContactResult> listCasesForContactAsync(ListCasesForContactRequest request, AsyncHandler<ListCasesForContactRequest,ListCasesForContactResult> asyncHandler)
AmazonConnectCasesAsyncLists cases for a given contact.
listCasesForContactAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request)
AmazonConnectCasesAsyncLists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
listDomainsAsync in interface AmazonConnectCasesAsyncpublic Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
AmazonConnectCasesAsyncLists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
listDomainsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFieldOptionsResult> listFieldOptionsAsync(ListFieldOptionsRequest request)
AmazonConnectCasesAsyncLists all of the field options for a field identifier in the domain.
listFieldOptionsAsync in interface AmazonConnectCasesAsyncpublic Future<ListFieldOptionsResult> listFieldOptionsAsync(ListFieldOptionsRequest request, AsyncHandler<ListFieldOptionsRequest,ListFieldOptionsResult> asyncHandler)
AmazonConnectCasesAsyncLists all of the field options for a field identifier in the domain.
listFieldOptionsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFieldsResult> listFieldsAsync(ListFieldsRequest request)
AmazonConnectCasesAsyncLists all fields in a Cases domain.
listFieldsAsync in interface AmazonConnectCasesAsyncpublic Future<ListFieldsResult> listFieldsAsync(ListFieldsRequest request, AsyncHandler<ListFieldsRequest,ListFieldsResult> asyncHandler)
AmazonConnectCasesAsyncLists all fields in a Cases domain.
listFieldsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLayoutsResult> listLayoutsAsync(ListLayoutsRequest request)
AmazonConnectCasesAsyncLists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayoutsAsync in interface AmazonConnectCasesAsyncpublic Future<ListLayoutsResult> listLayoutsAsync(ListLayoutsRequest request, AsyncHandler<ListLayoutsRequest,ListLayoutsResult> asyncHandler)
AmazonConnectCasesAsyncLists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayoutsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonConnectCasesAsyncLists tags for a resource.
listTagsForResourceAsync in interface AmazonConnectCasesAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonConnectCasesAsyncLists tags for a resource.
listTagsForResourceAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest request)
AmazonConnectCasesAsyncLists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplatesAsync in interface AmazonConnectCasesAsyncpublic Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest request, AsyncHandler<ListTemplatesRequest,ListTemplatesResult> asyncHandler)
AmazonConnectCasesAsyncLists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplatesAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutCaseEventConfigurationResult> putCaseEventConfigurationAsync(PutCaseEventConfigurationRequest request)
AmazonConnectCasesAsyncAdds 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
putCaseEventConfigurationAsync in interface AmazonConnectCasesAsyncpublic Future<PutCaseEventConfigurationResult> putCaseEventConfigurationAsync(PutCaseEventConfigurationRequest request, AsyncHandler<PutCaseEventConfigurationRequest,PutCaseEventConfigurationResult> asyncHandler)
AmazonConnectCasesAsyncAdds 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
putCaseEventConfigurationAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchCasesResult> searchCasesAsync(SearchCasesRequest request)
AmazonConnectCasesAsyncSearches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For 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
.
searchCasesAsync in interface AmazonConnectCasesAsyncpublic Future<SearchCasesResult> searchCasesAsync(SearchCasesRequest request, AsyncHandler<SearchCasesRequest,SearchCasesResult> asyncHandler)
AmazonConnectCasesAsyncSearches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For 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
.
searchCasesAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchRelatedItemsResult> searchRelatedItemsAsync(SearchRelatedItemsRequest request)
AmazonConnectCasesAsyncSearches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
searchRelatedItemsAsync in interface AmazonConnectCasesAsyncpublic Future<SearchRelatedItemsResult> searchRelatedItemsAsync(SearchRelatedItemsRequest request, AsyncHandler<SearchRelatedItemsRequest,SearchRelatedItemsResult> asyncHandler)
AmazonConnectCasesAsyncSearches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
searchRelatedItemsAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonConnectCasesAsyncAdds tags to a resource.
tagResourceAsync in interface AmazonConnectCasesAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonConnectCasesAsyncAdds tags to a resource.
tagResourceAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonConnectCasesAsyncUntags a resource.
untagResourceAsync in interface AmazonConnectCasesAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonConnectCasesAsyncUntags a resource.
untagResourceAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateCaseResult> updateCaseAsync(UpdateCaseRequest request)
AmazonConnectCasesAsync
If you provide a value for 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>
updateCaseAsync in interface AmazonConnectCasesAsyncpublic Future<UpdateCaseResult> updateCaseAsync(UpdateCaseRequest request, AsyncHandler<UpdateCaseRequest,UpdateCaseResult> asyncHandler)
AmazonConnectCasesAsync
If you provide a value for 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>
updateCaseAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateFieldResult> updateFieldAsync(UpdateFieldRequest request)
AmazonConnectCasesAsyncUpdates the properties of an existing field.
updateFieldAsync in interface AmazonConnectCasesAsyncpublic Future<UpdateFieldResult> updateFieldAsync(UpdateFieldRequest request, AsyncHandler<UpdateFieldRequest,UpdateFieldResult> asyncHandler)
AmazonConnectCasesAsyncUpdates the properties of an existing field.
updateFieldAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLayoutResult> updateLayoutAsync(UpdateLayoutRequest request)
AmazonConnectCasesAsyncUpdates 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.
Title and Status fields cannot be part of layouts because they are not configurable.
updateLayoutAsync in interface AmazonConnectCasesAsyncpublic Future<UpdateLayoutResult> updateLayoutAsync(UpdateLayoutRequest request, AsyncHandler<UpdateLayoutRequest,UpdateLayoutResult> asyncHandler)
AmazonConnectCasesAsyncUpdates 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.
Title and Status fields cannot be part of layouts because they are not configurable.
updateLayoutAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest request)
AmazonConnectCasesAsync
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.
updateTemplateAsync in interface AmazonConnectCasesAsyncpublic Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest request, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResult> asyncHandler)
AmazonConnectCasesAsync
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.
updateTemplateAsync in interface AmazonConnectCasesAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonConnectCasesshutdown in class AmazonConnectCasesClient