@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectCasesAsync extends AmazonConnectCases
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnectCasesAsync instead.
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.
ENDPOINT_PREFIXbatchGetField, 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, shutdown, tagResource, untagResource, updateCase, updateField, updateLayout, updateTemplateFuture<BatchGetFieldResult> batchGetFieldAsync(BatchGetFieldRequest batchGetFieldRequest)
Returns the description for the list of fields in the request parameters.
batchGetFieldRequest - Future<BatchGetFieldResult> batchGetFieldAsync(BatchGetFieldRequest batchGetFieldRequest, AsyncHandler<BatchGetFieldRequest,BatchGetFieldResult> asyncHandler)
Returns the description for the list of fields in the request parameters.
batchGetFieldRequest - asyncHandler - 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.Future<BatchPutFieldOptionsResult> batchPutFieldOptionsAsync(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)
Creates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptionsRequest - Future<BatchPutFieldOptionsResult> batchPutFieldOptionsAsync(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest, AsyncHandler<BatchPutFieldOptionsRequest,BatchPutFieldOptionsResult> asyncHandler)
Creates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptionsRequest - asyncHandler - 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.Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest)
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>
createCaseRequest - Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest, AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
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>
createCaseRequest - asyncHandler - 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.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
</important>
createDomainRequest - Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
</important>
createDomainRequest - asyncHandler - 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.Future<CreateFieldResult> createFieldAsync(CreateFieldRequest createFieldRequest)
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.
createFieldRequest - Future<CreateFieldResult> createFieldAsync(CreateFieldRequest createFieldRequest, AsyncHandler<CreateFieldRequest,CreateFieldResult> asyncHandler)
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.
createFieldRequest - asyncHandler - 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.Future<CreateLayoutResult> createLayoutAsync(CreateLayoutRequest createLayoutRequest)
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
Title and Status fields cannot be part of layouts since they are not configurable.
createLayoutRequest - Future<CreateLayoutResult> createLayoutAsync(CreateLayoutRequest createLayoutRequest, AsyncHandler<CreateLayoutRequest,CreateLayoutResult> asyncHandler)
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
Title and Status fields cannot be part of layouts since they are not configurable.
createLayoutRequest - asyncHandler - 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.Future<CreateRelatedItemResult> createRelatedItemAsync(CreateRelatedItemRequest createRelatedItemRequest)
Creates 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>
createRelatedItemRequest - Future<CreateRelatedItemResult> createRelatedItemAsync(CreateRelatedItemRequest createRelatedItemRequest, AsyncHandler<CreateRelatedItemRequest,CreateRelatedItemResult> asyncHandler)
Creates 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>
createRelatedItemRequest - asyncHandler - 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.Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest createTemplateRequest)
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.
createTemplateRequest - Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest createTemplateRequest, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
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.
createTemplateRequest - asyncHandler - 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.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
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>
deleteDomainRequest - Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
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>
deleteDomainRequest - asyncHandler - 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.Future<DeleteFieldResult> deleteFieldAsync(DeleteFieldRequest deleteFieldRequest)
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 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.
deleteFieldRequest - Future<DeleteFieldResult> deleteFieldAsync(DeleteFieldRequest deleteFieldRequest, AsyncHandler<DeleteFieldRequest,DeleteFieldResult> asyncHandler)
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 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.
deleteFieldRequest - asyncHandler - 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.Future<DeleteLayoutResult> deleteLayoutAsync(DeleteLayoutRequest deleteLayoutRequest)
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>
deleteLayoutRequest - Future<DeleteLayoutResult> deleteLayoutAsync(DeleteLayoutRequest deleteLayoutRequest, AsyncHandler<DeleteLayoutRequest,DeleteLayoutResult> asyncHandler)
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>
deleteLayoutRequest - asyncHandler - 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.Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest deleteTemplateRequest)
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>
deleteTemplateRequest - Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest deleteTemplateRequest, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
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>
deleteTemplateRequest - asyncHandler - 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.Future<GetCaseResult> getCaseAsync(GetCaseRequest getCaseRequest)
Returns information about a specific case if it exists.
getCaseRequest - Future<GetCaseResult> getCaseAsync(GetCaseRequest getCaseRequest, AsyncHandler<GetCaseRequest,GetCaseResult> asyncHandler)
Returns information about a specific case if it exists.
getCaseRequest - asyncHandler - 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.Future<GetCaseAuditEventsResult> getCaseAuditEventsAsync(GetCaseAuditEventsRequest getCaseAuditEventsRequest)
Returns the audit history about a specific case if it exists.
getCaseAuditEventsRequest - Future<GetCaseAuditEventsResult> getCaseAuditEventsAsync(GetCaseAuditEventsRequest getCaseAuditEventsRequest, AsyncHandler<GetCaseAuditEventsRequest,GetCaseAuditEventsResult> asyncHandler)
Returns the audit history about a specific case if it exists.
getCaseAuditEventsRequest - asyncHandler - 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.Future<GetCaseEventConfigurationResult> getCaseEventConfigurationAsync(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)
Returns the case event publishing configuration.
getCaseEventConfigurationRequest - Future<GetCaseEventConfigurationResult> getCaseEventConfigurationAsync(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest, AsyncHandler<GetCaseEventConfigurationRequest,GetCaseEventConfigurationResult> asyncHandler)
Returns the case event publishing configuration.
getCaseEventConfigurationRequest - asyncHandler - 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.Future<GetDomainResult> getDomainAsync(GetDomainRequest getDomainRequest)
Returns information about a specific domain if it exists.
getDomainRequest - Future<GetDomainResult> getDomainAsync(GetDomainRequest getDomainRequest, AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
Returns information about a specific domain if it exists.
getDomainRequest - asyncHandler - 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.Future<GetLayoutResult> getLayoutAsync(GetLayoutRequest getLayoutRequest)
Returns the details for the requested layout.
getLayoutRequest - Future<GetLayoutResult> getLayoutAsync(GetLayoutRequest getLayoutRequest, AsyncHandler<GetLayoutRequest,GetLayoutResult> asyncHandler)
Returns the details for the requested layout.
getLayoutRequest - asyncHandler - 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.Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the details for the requested template.
getTemplateRequest - Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest, AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
Returns the details for the requested template.
getTemplateRequest - asyncHandler - 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.Future<ListCasesForContactResult> listCasesForContactAsync(ListCasesForContactRequest listCasesForContactRequest)
Lists cases for a given contact.
listCasesForContactRequest - Future<ListCasesForContactResult> listCasesForContactAsync(ListCasesForContactRequest listCasesForContactRequest, AsyncHandler<ListCasesForContactRequest,ListCasesForContactResult> asyncHandler)
Lists cases for a given contact.
listCasesForContactRequest - asyncHandler - 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.Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest)
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
listDomainsRequest - Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
listDomainsRequest - asyncHandler - 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.Future<ListFieldOptionsResult> listFieldOptionsAsync(ListFieldOptionsRequest listFieldOptionsRequest)
Lists all of the field options for a field identifier in the domain.
listFieldOptionsRequest - Future<ListFieldOptionsResult> listFieldOptionsAsync(ListFieldOptionsRequest listFieldOptionsRequest, AsyncHandler<ListFieldOptionsRequest,ListFieldOptionsResult> asyncHandler)
Lists all of the field options for a field identifier in the domain.
listFieldOptionsRequest - asyncHandler - 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.Future<ListFieldsResult> listFieldsAsync(ListFieldsRequest listFieldsRequest)
Lists all fields in a Cases domain.
listFieldsRequest - Future<ListFieldsResult> listFieldsAsync(ListFieldsRequest listFieldsRequest, AsyncHandler<ListFieldsRequest,ListFieldsResult> asyncHandler)
Lists all fields in a Cases domain.
listFieldsRequest - asyncHandler - 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.Future<ListLayoutsResult> listLayoutsAsync(ListLayoutsRequest listLayoutsRequest)
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayoutsRequest - Future<ListLayoutsResult> listLayoutsAsync(ListLayoutsRequest listLayoutsRequest, AsyncHandler<ListLayoutsRequest,ListLayoutsResult> asyncHandler)
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayoutsRequest - asyncHandler - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for a resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists tags for a resource.
listTagsForResourceRequest - asyncHandler - 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.Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest listTemplatesRequest)
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplatesRequest - Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest listTemplatesRequest, AsyncHandler<ListTemplatesRequest,ListTemplatesResult> asyncHandler)
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplatesRequest - asyncHandler - 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.Future<PutCaseEventConfigurationResult> putCaseEventConfigurationAsync(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)
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
putCaseEventConfigurationRequest - Future<PutCaseEventConfigurationResult> putCaseEventConfigurationAsync(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest, AsyncHandler<PutCaseEventConfigurationRequest,PutCaseEventConfigurationResult> asyncHandler)
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
putCaseEventConfigurationRequest - asyncHandler - 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.Future<SearchCasesResult> searchCasesAsync(SearchCasesRequest searchCasesRequest)
Searches 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
.
searchCasesRequest - Future<SearchCasesResult> searchCasesAsync(SearchCasesRequest searchCasesRequest, AsyncHandler<SearchCasesRequest,SearchCasesResult> asyncHandler)
Searches 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
.
searchCasesRequest - asyncHandler - 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.Future<SearchRelatedItemsResult> searchRelatedItemsAsync(SearchRelatedItemsRequest searchRelatedItemsRequest)
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
searchRelatedItemsRequest - Future<SearchRelatedItemsResult> searchRelatedItemsAsync(SearchRelatedItemsRequest searchRelatedItemsRequest, AsyncHandler<SearchRelatedItemsRequest,SearchRelatedItemsResult> asyncHandler)
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
searchRelatedItemsRequest - asyncHandler - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds tags to a resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds tags to a resource.
tagResourceRequest - asyncHandler - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Untags a resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Untags a resource.
untagResourceRequest - asyncHandler - 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.Future<UpdateCaseResult> updateCaseAsync(UpdateCaseRequest updateCaseRequest)
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>
updateCaseRequest - Future<UpdateCaseResult> updateCaseAsync(UpdateCaseRequest updateCaseRequest, AsyncHandler<UpdateCaseRequest,UpdateCaseResult> asyncHandler)
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>
updateCaseRequest - asyncHandler - 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.Future<UpdateFieldResult> updateFieldAsync(UpdateFieldRequest updateFieldRequest)
Updates the properties of an existing field.
updateFieldRequest - Future<UpdateFieldResult> updateFieldAsync(UpdateFieldRequest updateFieldRequest, AsyncHandler<UpdateFieldRequest,UpdateFieldResult> asyncHandler)
Updates the properties of an existing field.
updateFieldRequest - asyncHandler - 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.Future<UpdateLayoutResult> updateLayoutAsync(UpdateLayoutRequest updateLayoutRequest)
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.
Title and Status fields cannot be part of layouts because they are not configurable.
updateLayoutRequest - Future<UpdateLayoutResult> updateLayoutAsync(UpdateLayoutRequest updateLayoutRequest, AsyncHandler<UpdateLayoutRequest,UpdateLayoutResult> asyncHandler)
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.
Title and Status fields cannot be part of layouts because they are not configurable.
updateLayoutRequest - asyncHandler - 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.Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest updateTemplateRequest)
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.
updateTemplateRequest - Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest updateTemplateRequest, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResult> asyncHandler)
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.
updateTemplateRequest - asyncHandler - 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.