Interface ConnectCasesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface ConnectCasesClient
extends AwsClient

Service client for accessing ConnectCases. This can be created using the static builder() method.

• Cases actions

• Cases data types

With Connect Customer 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 Connect Customer Cases in the Connect Customer Administrator Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchCreateRelatedItemResponse	batchCreateRelatedItem(Consumer<BatchCreateRelatedItemRequest.Builder> batchCreateRelatedItemRequest)	Creates a comment and associates it with multiple cases in a single request.
default BatchCreateRelatedItemResponse	batchCreateRelatedItem(BatchCreateRelatedItemRequest batchCreateRelatedItemRequest)	Creates a comment and associates it with multiple cases in a single request.
default BatchGetCaseRuleResponse	batchGetCaseRule(Consumer<BatchGetCaseRuleRequest.Builder> batchGetCaseRuleRequest)	Gets a batch of case rules.
default BatchGetCaseRuleResponse	batchGetCaseRule(BatchGetCaseRuleRequest batchGetCaseRuleRequest)	Gets a batch of case rules.
default BatchGetFieldResponse	batchGetField(Consumer<BatchGetFieldRequest.Builder> batchGetFieldRequest)	Returns the description for the list of fields in the request parameters.
default BatchGetFieldResponse	batchGetField(BatchGetFieldRequest batchGetFieldRequest)	Returns the description for the list of fields in the request parameters.
default BatchPutFieldOptionsResponse	batchPutFieldOptions(Consumer<BatchPutFieldOptionsRequest.Builder> batchPutFieldOptionsRequest)	Creates and updates a set of field options for a single select field in a Cases domain.
default BatchPutFieldOptionsResponse	batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)	Creates and updates a set of field options for a single select field in a Cases domain.
default BatchUpdateCaseResponse	batchUpdateCase(Consumer<BatchUpdateCaseRequest.Builder> batchUpdateCaseRequest)	Updates fields on multiple cases in a single request.
default BatchUpdateCaseResponse	batchUpdateCase(BatchUpdateCaseRequest batchUpdateCaseRequest)	Updates fields on multiple cases in a single request.
static ConnectCasesClientBuilder	builder()	Create a builder that can be used to configure and create a ConnectCasesClient.
static ConnectCasesClient	create()	Create a ConnectCasesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCaseResponse	createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
default CreateCaseResponse	createCase(CreateCaseRequest createCaseRequest)
default CreateCaseRuleResponse	createCaseRule(Consumer<CreateCaseRuleRequest.Builder> createCaseRuleRequest)	Creates a new case rule.
default CreateCaseRuleResponse	createCaseRule(CreateCaseRuleRequest createCaseRuleRequest)	Creates a new case rule.
default CreateDomainResponse	createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)	Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
default CreateDomainResponse	createDomain(CreateDomainRequest createDomainRequest)	Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
default CreateFieldResponse	createField(Consumer<CreateFieldRequest.Builder> createFieldRequest)	Creates a field in the Cases domain.
default CreateFieldResponse	createField(CreateFieldRequest createFieldRequest)	Creates a field in the Cases domain.
default CreateLayoutResponse	createLayout(Consumer<CreateLayoutRequest.Builder> createLayoutRequest)	Creates a layout in the Cases domain.
default CreateLayoutResponse	createLayout(CreateLayoutRequest createLayoutRequest)	Creates a layout in the Cases domain.
default CreateRelatedItemResponse	createRelatedItem(Consumer<CreateRelatedItemRequest.Builder> createRelatedItemRequest)	Creates a related item (comments, tasks, and contacts) and associates it with a case.
default CreateRelatedItemResponse	createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest)	Creates a related item (comments, tasks, and contacts) and associates it with a case.
default CreateTemplateResponse	createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)	Creates a template in the Cases domain.
default CreateTemplateResponse	createTemplate(CreateTemplateRequest createTemplateRequest)	Creates a template in the Cases domain.
default DeleteCaseResponse	deleteCase(Consumer<DeleteCaseRequest.Builder> deleteCaseRequest)	The DeleteCase API permanently deletes a case and all its associated resources from the cases data store.
default DeleteCaseResponse	deleteCase(DeleteCaseRequest deleteCaseRequest)	The DeleteCase API permanently deletes a case and all its associated resources from the cases data store.
default DeleteCaseRuleResponse	deleteCaseRule(Consumer<DeleteCaseRuleRequest.Builder> deleteCaseRuleRequest)	Deletes a case rule.
default DeleteCaseRuleResponse	deleteCaseRule(DeleteCaseRuleRequest deleteCaseRuleRequest)	Deletes a case rule.
default DeleteDomainResponse	deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)	Deletes a Cases domain.
default DeleteDomainResponse	deleteDomain(DeleteDomainRequest deleteDomainRequest)	Deletes a Cases domain.
default DeleteFieldResponse	deleteField(Consumer<DeleteFieldRequest.Builder> deleteFieldRequest)	Deletes a field from a Cases template.
default DeleteFieldResponse	deleteField(DeleteFieldRequest deleteFieldRequest)	Deletes a field from a Cases template.
default DeleteLayoutResponse	deleteLayout(Consumer<DeleteLayoutRequest.Builder> deleteLayoutRequest)	Deletes a layout from a Cases template.
default DeleteLayoutResponse	deleteLayout(DeleteLayoutRequest deleteLayoutRequest)	Deletes a layout from a Cases template.
default DeleteRelatedItemResponse	deleteRelatedItem(Consumer<DeleteRelatedItemRequest.Builder> deleteRelatedItemRequest)	Deletes the related item resource under a case.
default DeleteRelatedItemResponse	deleteRelatedItem(DeleteRelatedItemRequest deleteRelatedItemRequest)	Deletes the related item resource under a case.
default DeleteTemplateResponse	deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)	Deletes a Cases template.
default DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)	Deletes a Cases template.
default GetCaseResponse	getCase(Consumer<GetCaseRequest.Builder> getCaseRequest)	Returns information about a specific case if it exists.
default GetCaseResponse	getCase(GetCaseRequest getCaseRequest)	Returns information about a specific case if it exists.
default GetCaseAuditEventsResponse	getCaseAuditEvents(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)	Returns the audit history about a specific case if it exists.
default GetCaseAuditEventsResponse	getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest)	Returns the audit history about a specific case if it exists.
default GetCaseAuditEventsIterable	getCaseAuditEventsPaginator(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)	This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation.
default GetCaseAuditEventsIterable	getCaseAuditEventsPaginator(GetCaseAuditEventsRequest getCaseAuditEventsRequest)	This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation.
default GetCaseEventConfigurationResponse	getCaseEventConfiguration(Consumer<GetCaseEventConfigurationRequest.Builder> getCaseEventConfigurationRequest)	Returns the case event publishing configuration.
default GetCaseEventConfigurationResponse	getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)	Returns the case event publishing configuration.
default GetCaseIterable	getCasePaginator(Consumer<GetCaseRequest.Builder> getCaseRequest)	This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation.
default GetCaseIterable	getCasePaginator(GetCaseRequest getCaseRequest)	This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation.
default GetDomainResponse	getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)	Returns information about a specific domain if it exists.
default GetDomainResponse	getDomain(GetDomainRequest getDomainRequest)	Returns information about a specific domain if it exists.
default GetLayoutResponse	getLayout(Consumer<GetLayoutRequest.Builder> getLayoutRequest)	Returns the details for the requested layout.
default GetLayoutResponse	getLayout(GetLayoutRequest getLayoutRequest)	Returns the details for the requested layout.
default GetMergeCasesStatusResponse	getMergeCasesStatus(Consumer<GetMergeCasesStatusRequest.Builder> getMergeCasesStatusRequest)	Returns the merge status of a case.
default GetMergeCasesStatusResponse	getMergeCasesStatus(GetMergeCasesStatusRequest getMergeCasesStatusRequest)	Returns the merge status of a case.
default GetTemplateResponse	getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)	Returns the details for the requested template.
default GetTemplateResponse	getTemplate(GetTemplateRequest getTemplateRequest)	Returns the details for the requested template.
default ListCaseRulesResponse	listCaseRules(Consumer<ListCaseRulesRequest.Builder> listCaseRulesRequest)	Lists all case rules in a Cases domain.
default ListCaseRulesResponse	listCaseRules(ListCaseRulesRequest listCaseRulesRequest)	Lists all case rules in a Cases domain.
default ListCaseRulesIterable	listCaseRulesPaginator(Consumer<ListCaseRulesRequest.Builder> listCaseRulesRequest)	This is a variant of listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation.
default ListCaseRulesIterable	listCaseRulesPaginator(ListCaseRulesRequest listCaseRulesRequest)	This is a variant of listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation.
default ListCasesForContactResponse	listCasesForContact(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)	Lists cases for a given contact.
default ListCasesForContactResponse	listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)	Lists cases for a given contact.
default ListCasesForContactIterable	listCasesForContactPaginator(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)	This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation.
default ListCasesForContactIterable	listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest)	This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	Lists all cases domains in the Amazon Web Services account.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest)	Lists all cases domains in the Amazon Web Services account.
default ListDomainsIterable	listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation.
default ListDomainsIterable	listDomainsPaginator(ListDomainsRequest listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation.
default ListFieldOptionsResponse	listFieldOptions(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)	Lists all of the field options for a field identifier in the domain.
default ListFieldOptionsResponse	listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)	Lists all of the field options for a field identifier in the domain.
default ListFieldOptionsIterable	listFieldOptionsPaginator(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)	This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation.
default ListFieldOptionsIterable	listFieldOptionsPaginator(ListFieldOptionsRequest listFieldOptionsRequest)	This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation.
default ListFieldsResponse	listFields(Consumer<ListFieldsRequest.Builder> listFieldsRequest)	Lists all fields in a Cases domain.
default ListFieldsResponse	listFields(ListFieldsRequest listFieldsRequest)	Lists all fields in a Cases domain.
default ListFieldsIterable	listFieldsPaginator(Consumer<ListFieldsRequest.Builder> listFieldsRequest)	This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation.
default ListFieldsIterable	listFieldsPaginator(ListFieldsRequest listFieldsRequest)	This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation.
default ListLayoutsResponse	listLayouts(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)	Lists all layouts in the given cases domain.
default ListLayoutsResponse	listLayouts(ListLayoutsRequest listLayoutsRequest)	Lists all layouts in the given cases domain.
default ListLayoutsIterable	listLayoutsPaginator(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)	This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation.
default ListLayoutsIterable	listLayoutsPaginator(ListLayoutsRequest listLayoutsRequest)	This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists tags for a resource.
default ListTemplatesResponse	listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)	Lists all of the templates in a Cases domain.
default ListTemplatesResponse	listTemplates(ListTemplatesRequest listTemplatesRequest)	Lists all of the templates in a Cases domain.
default ListTemplatesIterable	listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)	This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation.
default ListTemplatesIterable	listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)	This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation.
default PutCaseEventConfigurationResponse	putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest)	Adds case event publishing configuration.
default PutCaseEventConfigurationResponse	putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)	Adds case event publishing configuration.
default SearchAllRelatedItemsResponse	searchAllRelatedItems(Consumer<SearchAllRelatedItemsRequest.Builder> searchAllRelatedItemsRequest)	Searches for related items across all cases within a domain.
default SearchAllRelatedItemsResponse	searchAllRelatedItems(SearchAllRelatedItemsRequest searchAllRelatedItemsRequest)	Searches for related items across all cases within a domain.
default SearchAllRelatedItemsIterable	searchAllRelatedItemsPaginator(Consumer<SearchAllRelatedItemsRequest.Builder> searchAllRelatedItemsRequest)	This is a variant of searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation.
default SearchAllRelatedItemsIterable	searchAllRelatedItemsPaginator(SearchAllRelatedItemsRequest searchAllRelatedItemsRequest)	This is a variant of searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation.
default SearchCasesResponse	searchCases(Consumer<SearchCasesRequest.Builder> searchCasesRequest)	Searches for cases within their associated Cases domain.
default SearchCasesResponse	searchCases(SearchCasesRequest searchCasesRequest)	Searches for cases within their associated Cases domain.
default SearchCasesIterable	searchCasesPaginator(Consumer<SearchCasesRequest.Builder> searchCasesRequest)	This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation.
default SearchCasesIterable	searchCasesPaginator(SearchCasesRequest searchCasesRequest)	This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation.
default SearchRelatedItemsResponse	searchRelatedItems(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)	Searches for related items that are associated with a case.
default SearchRelatedItemsResponse	searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest)	Searches for related items that are associated with a case.
default SearchRelatedItemsIterable	searchRelatedItemsPaginator(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)	This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation.
default SearchRelatedItemsIterable	searchRelatedItemsPaginator(SearchRelatedItemsRequest searchRelatedItemsRequest)	This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation.
default ConnectCasesServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartMergeCasesResponse	startMergeCases(Consumer<StartMergeCasesRequest.Builder> startMergeCasesRequest)	Merges a secondary case into a primary case.
default StartMergeCasesResponse	startMergeCases(StartMergeCasesRequest startMergeCasesRequest)	Merges a secondary case into a primary case.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Untags a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Untags a resource.
default UpdateCaseResponse	updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest)
default UpdateCaseResponse	updateCase(UpdateCaseRequest updateCaseRequest)
default UpdateCaseRuleResponse	updateCaseRule(Consumer<UpdateCaseRuleRequest.Builder> updateCaseRuleRequest)	Updates a case rule.
default UpdateCaseRuleResponse	updateCaseRule(UpdateCaseRuleRequest updateCaseRuleRequest)	Updates a case rule.
default UpdateFieldResponse	updateField(Consumer<UpdateFieldRequest.Builder> updateFieldRequest)	Updates the properties of an existing field.
default UpdateFieldResponse	updateField(UpdateFieldRequest updateFieldRequest)	Updates the properties of an existing field.
default UpdateLayoutResponse	updateLayout(Consumer<UpdateLayoutRequest.Builder> updateLayoutRequest)	Updates the attributes of an existing layout.
default UpdateLayoutResponse	updateLayout(UpdateLayoutRequest updateLayoutRequest)	Updates the attributes of an existing layout.
default UpdateRelatedItemResponse	updateRelatedItem(Consumer<UpdateRelatedItemRequest.Builder> updateRelatedItemRequest)	Updates the content of a related item associated with a case.
default UpdateRelatedItemResponse	updateRelatedItem(UpdateRelatedItemRequest updateRelatedItemRequest)	Updates the content of a related item associated with a case.
default UpdateTemplateResponse	updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)	Updates the attributes of an existing template.
default UpdateTemplateResponse	updateTemplate(UpdateTemplateRequest updateTemplateRequest)	Updates the attributes of an existing template.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchCreateRelatedItem

default BatchCreateRelatedItemResponse batchCreateRelatedItem(BatchCreateRelatedItemRequest batchCreateRelatedItemRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a comment and associates it with multiple cases in a single request. All cases must belong to the same domain. This operation supports only the Comment related item type.

Each case is processed independently. If some cases fail, the remaining cases still receive the related item. To determine whether individual items failed, inspect the failedItems array in the response.

The entire request fails, and no related items are created, in the following cases:

• The specified domain doesn't exist.

• A reference ID doesn't match any case in the domain.

• The request contains duplicate case IDs.

• The content isn't comment content.

This operation uses the same IAM action as CreateRelatedItem ( cases:CreateRelatedItem). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.

If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

batchCreateRelatedItemRequest -

Returns:

Result of the BatchCreateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

batchCreateRelatedItem

default BatchCreateRelatedItemResponse batchCreateRelatedItem(Consumer<BatchCreateRelatedItemRequest.Builder> batchCreateRelatedItemRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a comment and associates it with multiple cases in a single request. All cases must belong to the same domain. This operation supports only the Comment related item type.

Each case is processed independently. If some cases fail, the remaining cases still receive the related item. To determine whether individual items failed, inspect the failedItems array in the response.

The entire request fails, and no related items are created, in the following cases:

• The specified domain doesn't exist.

• A reference ID doesn't match any case in the domain.

• The request contains duplicate case IDs.

• The content isn't comment content.

This operation uses the same IAM action as CreateRelatedItem ( cases:CreateRelatedItem). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.

If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the BatchCreateRelatedItemRequest.Builder avoiding the need to create one manually via BatchCreateRelatedItemRequest.builder()

Parameters:

batchCreateRelatedItemRequest - A Consumer that will call methods on BatchCreateRelatedItemRequest.Builder to create a request.

Returns:

Result of the BatchCreateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

batchGetCaseRule

default BatchGetCaseRuleResponse batchGetCaseRule(BatchGetCaseRuleRequest batchGetCaseRuleRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Gets a batch of case rules. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

batchGetCaseRuleRequest -

Returns:

Result of the BatchGetCaseRule operation returned by the service.

See Also:

• AWS API Documentation

batchGetCaseRule

default BatchGetCaseRuleResponse batchGetCaseRule(Consumer<BatchGetCaseRuleRequest.Builder> batchGetCaseRuleRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Gets a batch of case rules. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

This is a convenience which creates an instance of the BatchGetCaseRuleRequest.Builder avoiding the need to create one manually via BatchGetCaseRuleRequest.builder()

Parameters:

batchGetCaseRuleRequest - A Consumer that will call methods on BatchGetCaseRuleRequest.Builder to create a request.

Returns:

Result of the BatchGetCaseRule operation returned by the service.

See Also:

• AWS API Documentation

batchGetField

default BatchGetFieldResponse batchGetField(BatchGetFieldRequest batchGetFieldRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the description for the list of fields in the request parameters.

Parameters:

batchGetFieldRequest -

Returns:

Result of the BatchGetField operation returned by the service.

See Also:

• AWS API Documentation

batchGetField

default BatchGetFieldResponse batchGetField(Consumer<BatchGetFieldRequest.Builder> batchGetFieldRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the description for the list of fields in the request parameters.

This is a convenience which creates an instance of the BatchGetFieldRequest.Builder avoiding the need to create one manually via BatchGetFieldRequest.builder()

Parameters:

batchGetFieldRequest - A Consumer that will call methods on BatchGetFieldRequest.Builder to create a request.

Returns:

Result of the BatchGetField operation returned by the service.

See Also:

• AWS API Documentation

batchPutFieldOptions

default BatchPutFieldOptionsResponse batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates and updates a set of field options for a single select field in a Cases domain.

Parameters:

batchPutFieldOptionsRequest -

Returns:

Result of the BatchPutFieldOptions operation returned by the service.

See Also:

• AWS API Documentation

batchPutFieldOptions

default BatchPutFieldOptionsResponse batchPutFieldOptions(Consumer<BatchPutFieldOptionsRequest.Builder> batchPutFieldOptionsRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates and updates a set of field options for a single select field in a Cases domain.

This is a convenience which creates an instance of the BatchPutFieldOptionsRequest.Builder avoiding the need to create one manually via BatchPutFieldOptionsRequest.builder()

Parameters:

batchPutFieldOptionsRequest - A Consumer that will call methods on BatchPutFieldOptionsRequest.Builder to create a request.

Returns:

Result of the BatchPutFieldOptions operation returned by the service.

See Also:

• AWS API Documentation

batchUpdateCase

default BatchUpdateCaseResponse batchUpdateCase(BatchUpdateCaseRequest batchUpdateCaseRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates fields on multiple cases in a single request. All cases must belong to the same domain. Set the title, status, and customer ID through the top-level title, status, and customerId parameters, and set other fields through the fields array.

Each case is processed independently. If some cases fail, the remaining cases are still updated. To determine whether individual cases failed, inspect the failedCases array in the response.

The entire request fails, and no cases are updated, in the following cases:

• The specified domain doesn't exist.

• A reference ID doesn't match any case in the domain.

• The request contains duplicate case IDs.

• The request doesn't specify any update. Provide at least one entry in fields, or a title, status, or customerId.

• A field identifier in fields doesn't resolve to a field in the domain, for example, an unknown field name.

• A field name contains a pipe (|) or comma (,) character.

• fields includes title, status, or customerId.

This operation uses the same IAM action as UpdateCase ( cases:UpdateCase). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.

If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

batchUpdateCaseRequest -

Returns:

Result of the BatchUpdateCase operation returned by the service.

See Also:

• AWS API Documentation

batchUpdateCase

default BatchUpdateCaseResponse batchUpdateCase(Consumer<BatchUpdateCaseRequest.Builder> batchUpdateCaseRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates fields on multiple cases in a single request. All cases must belong to the same domain. Set the title, status, and customer ID through the top-level title, status, and customerId parameters, and set other fields through the fields array.

Each case is processed independently. If some cases fail, the remaining cases are still updated. To determine whether individual cases failed, inspect the failedCases array in the response.

The entire request fails, and no cases are updated, in the following cases:

• The specified domain doesn't exist.

• A reference ID doesn't match any case in the domain.

• The request contains duplicate case IDs.

• The request doesn't specify any update. Provide at least one entry in fields, or a title, status, or customerId.

• A field identifier in fields doesn't resolve to a field in the domain, for example, an unknown field name.

• A field name contains a pipe (|) or comma (,) character.

• fields includes title, status, or customerId.

This operation uses the same IAM action as UpdateCase ( cases:UpdateCase). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.

If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the BatchUpdateCaseRequest.Builder avoiding the need to create one manually via BatchUpdateCaseRequest.builder()

Parameters:

batchUpdateCaseRequest - A Consumer that will call methods on BatchUpdateCaseRequest.Builder to create a request.

Returns:

Result of the BatchUpdateCase operation returned by the service.

See Also:

• AWS API Documentation

createCase

default CreateCaseResponse createCase(CreateCaseRequest createCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN that you provide.

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.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following field is always required when creating a case:

• title

The following field may be required depending on the template configuration:

• customer_id - Required only if the template's requiredFields list includes customer_id. When required, provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account_ID:domains/your_profiles_domain_name/profiles/profile_ID . When not required, the field is optional and can be omitted, added, changed, or removed after case creation.

Parameters:

createCaseRequest -

Returns:

Result of the CreateCase operation returned by the service.

See Also:

• AWS API Documentation

createCase

default CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN that you provide.

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.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following field is always required when creating a case:

• title

The following field may be required depending on the template configuration:

• customer_id - Required only if the template's requiredFields list includes customer_id. When required, provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account_ID:domains/your_profiles_domain_name/profiles/profile_ID . When not required, the field is optional and can be omitted, added, changed, or removed after case creation.

This is a convenience which creates an instance of the CreateCaseRequest.Builder avoiding the need to create one manually via CreateCaseRequest.builder()

Parameters:

createCaseRequest - A Consumer that will call methods on CreateCaseRequest.Builder to create a request.

Returns:

Result of the CreateCase operation returned by the service.

See Also:

• AWS API Documentation

createCaseRule

default CreateCaseRuleResponse createCaseRule(CreateCaseRuleRequest createCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a new case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

createCaseRuleRequest -

Returns:

Result of the CreateCaseRule operation returned by the service.

See Also:

• AWS API Documentation

createCaseRule

default CreateCaseRuleResponse createCaseRule(Consumer<CreateCaseRuleRequest.Builder> createCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a new case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

This is a convenience which creates an instance of the CreateCaseRuleRequest.Builder avoiding the need to create one manually via CreateCaseRuleRequest.builder()

Parameters:

createCaseRuleRequest - A Consumer that will call methods on CreateCaseRuleRequest.Builder to create a request.

Returns:

Result of the CreateCaseRule operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest)
                                   throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Connect Customer instance can be associated with only one Cases domain.

This will not associate your connect instance to Cases domain. Instead, use the Connect Customer CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
                                   throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Connect Customer instance can be associated with only one Cases domain.

This will not associate your connect instance to Cases domain. Instead, use the Connect Customer CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to create one manually via CreateDomainRequest.builder()

Parameters:

createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createField

default CreateFieldResponse createField(CreateFieldRequest createFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Parameters:

createFieldRequest -

Returns:

Result of the CreateField operation returned by the service.

See Also:

• AWS API Documentation

createField

default CreateFieldResponse createField(Consumer<CreateFieldRequest.Builder> createFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

This is a convenience which creates an instance of the CreateFieldRequest.Builder avoiding the need to create one manually via CreateFieldRequest.builder()

Parameters:

createFieldRequest - A Consumer that will call methods on CreateFieldRequest.Builder to create a request.

Returns:

Result of the CreateField operation returned by the service.

See Also:

• AWS API Documentation

createLayout

default CreateLayoutResponse createLayout(CreateLayoutRequest createLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Parameters:

createLayoutRequest -

Returns:

Result of the CreateLayout operation returned by the service.

See Also:

• AWS API Documentation

createLayout

default CreateLayoutResponse createLayout(Consumer<CreateLayoutRequest.Builder> createLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

This is a convenience which creates an instance of the CreateLayoutRequest.Builder avoiding the need to create one manually via CreateLayoutRequest.builder()

Parameters:

createLayoutRequest - A Consumer that will call methods on CreateLayoutRequest.Builder to create a request.

Returns:

Result of the CreateLayout operation returned by the service.

See Also:

• AWS API Documentation

createRelatedItem

default CreateRelatedItemResponse createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a related item (comments, tasks, and contacts) and associates it with a case.

There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

Use cases

Following are examples of related items that you may want to associate with a case:

• Related contacts, such as calls, chats, emails tasks

• Comments, for agent notes

• SLAs, to capture target resolution goals

• Cases, to capture related Connect Customer Cases

• Files, such as policy documentation or customer-provided attachments

• Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

Important things to know

• If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn.

• 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.

• If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

createRelatedItemRequest -

Returns:

Result of the CreateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

createRelatedItem

default CreateRelatedItemResponse createRelatedItem(Consumer<CreateRelatedItemRequest.Builder> createRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Creates a related item (comments, tasks, and contacts) and associates it with a case.

There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

Use cases

Following are examples of related items that you may want to associate with a case:

• Related contacts, such as calls, chats, emails tasks

• Comments, for agent notes

• SLAs, to capture target resolution goals

• Cases, to capture related Connect Customer Cases

• Files, such as policy documentation or customer-provided attachments

• Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

Important things to know

• If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn.

• 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.

• If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the CreateRelatedItemRequest.Builder avoiding the need to create one manually via CreateRelatedItemRequest.builder()

Parameters:

createRelatedItemRequest - A Consumer that will call methods on CreateRelatedItemRequest.Builder to create a request.

Returns:

Result of the CreateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

createTemplate

default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Other template APIs are:

• DeleteTemplate

• GetTemplate

• ListTemplates

• UpdateTemplate

Parameters:

createTemplateRequest -

Returns:

Result of the CreateTemplate operation returned by the service.

See Also:

• AWS API Documentation

createTemplate

default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Other template APIs are:

• DeleteTemplate

• GetTemplate

• ListTemplates

• UpdateTemplate

This is a convenience which creates an instance of the CreateTemplateRequest.Builder avoiding the need to create one manually via CreateTemplateRequest.builder()

Parameters:

createTemplateRequest - A Consumer that will call methods on CreateTemplateRequest.Builder to create a request.

Returns:

Result of the CreateTemplate operation returned by the service.

See Also:

• AWS API Documentation

deleteCase

default DeleteCaseResponse deleteCase(DeleteCaseRequest deleteCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:

• Retrieve related items

• Access audit history

• Perform any operations that require the CaseID

You can't delete a case while it's part of a merge that is running, as either the primary or the secondary case. The request fails with a ConflictException. For more information, see StartMergeCases.

This action is irreversible. After you delete a case, you cannot recover its data.

Parameters:

deleteCaseRequest -

Returns:

Result of the DeleteCase operation returned by the service.

See Also:

• AWS API Documentation

deleteCase

default DeleteCaseResponse deleteCase(Consumer<DeleteCaseRequest.Builder> deleteCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:

• Retrieve related items

• Access audit history

• Perform any operations that require the CaseID

You can't delete a case while it's part of a merge that is running, as either the primary or the secondary case. The request fails with a ConflictException. For more information, see StartMergeCases.

This action is irreversible. After you delete a case, you cannot recover its data.

This is a convenience which creates an instance of the DeleteCaseRequest.Builder avoiding the need to create one manually via DeleteCaseRequest.builder()

Parameters:

deleteCaseRequest - A Consumer that will call methods on DeleteCaseRequest.Builder to create a request.

Returns:

Result of the DeleteCase operation returned by the service.

See Also:

• AWS API Documentation

deleteCaseRule

default DeleteCaseRuleResponse deleteCaseRule(DeleteCaseRuleRequest deleteCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

deleteCaseRuleRequest -

Returns:

Result of the DeleteCaseRule operation returned by the service.

See Also:

• AWS API Documentation

deleteCaseRule

default DeleteCaseRuleResponse deleteCaseRule(Consumer<DeleteCaseRuleRequest.Builder> deleteCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

This is a convenience which creates an instance of the DeleteCaseRuleRequest.Builder avoiding the need to create one manually via DeleteCaseRuleRequest.builder()

Parameters:

deleteCaseRuleRequest - A Consumer that will call methods on DeleteCaseRuleRequest.Builder to create a request.

Returns:

Result of the DeleteCaseRule operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a Cases domain.

After deleting your domain you must disassociate the deleted domain from your Connect Customer instance with another API call before being able to use Cases again with this Connect Customer instance. See DeleteIntegrationAssociation.

Parameters:

deleteDomainRequest -

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a Cases domain.

After deleting your domain you must disassociate the deleted domain from your Connect Customer instance with another API call before being able to use Cases again with this Connect Customer instance. See DeleteIntegrationAssociation.

This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to create one manually via DeleteDomainRequest.builder()

Parameters:

deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

deleteField

default DeleteFieldResponse deleteField(DeleteFieldRequest deleteFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a field from a Cases template.

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 identifiers in the request have been deleted.

• Calling GetCase with a deleted field identifier 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.

Parameters:

deleteFieldRequest -

Returns:

Result of the DeleteField operation returned by the service.

See Also:

• AWS API Documentation

deleteField

default DeleteFieldResponse deleteField(Consumer<DeleteFieldRequest.Builder> deleteFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a field from a Cases template.

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 identifiers in the request have been deleted.

• Calling GetCase with a deleted field identifier 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.

This is a convenience which creates an instance of the DeleteFieldRequest.Builder avoiding the need to create one manually via DeleteFieldRequest.builder()

Parameters:

deleteFieldRequest - A Consumer that will call methods on DeleteFieldRequest.Builder to create a request.

Returns:

Result of the DeleteField operation returned by the service.

See Also:

• AWS API Documentation

deleteLayout

default DeleteLayoutResponse deleteLayout(DeleteLayoutRequest deleteLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a layout from a Cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:

• You can still retrieve the layout by calling GetLayout.

• You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException.

• Deleted layouts are not included in the ListLayouts response.

Parameters:

deleteLayoutRequest -

Returns:

Result of the DeleteLayout operation returned by the service.

See Also:

• AWS API Documentation

deleteLayout

default DeleteLayoutResponse deleteLayout(Consumer<DeleteLayoutRequest.Builder> deleteLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a layout from a Cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:

• You can still retrieve the layout by calling GetLayout.

• You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException.

• Deleted layouts are not included in the ListLayouts response.

This is a convenience which creates an instance of the DeleteLayoutRequest.Builder avoiding the need to create one manually via DeleteLayoutRequest.builder()

Parameters:

deleteLayoutRequest - A Consumer that will call methods on DeleteLayoutRequest.Builder to create a request.

Returns:

Result of the DeleteLayout operation returned by the service.

See Also:

• AWS API Documentation

deleteRelatedItem

default DeleteRelatedItemResponse deleteRelatedItem(DeleteRelatedItemRequest deleteRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes the related item resource under a case.

This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API

If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Parameters:

deleteRelatedItemRequest -

Returns:

Result of the DeleteRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

deleteRelatedItem

default DeleteRelatedItemResponse deleteRelatedItem(Consumer<DeleteRelatedItemRequest.Builder> deleteRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes the related item resource under a case.

This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API

If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

This is a convenience which creates an instance of the DeleteRelatedItemRequest.Builder avoiding the need to create one manually via DeleteRelatedItemRequest.builder()

Parameters:

deleteRelatedItemRequest - A Consumer that will call methods on DeleteRelatedItemRequest.Builder to create a request.

Returns:

Result of the DeleteRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplate

default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a Cases template. You can delete up to 100 templates per domain.

After a Cases template is deleted:

• You can still retrieve the template by calling GetTemplate.

• You cannot update the template.

• You cannot create a case by using the deleted template.

• Deleted templates are not included in the ListTemplates response.

Parameters:

deleteTemplateRequest -

Returns:

Result of the DeleteTemplate operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplate

default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Deletes a Cases template. You can delete up to 100 templates per domain.

After a Cases template is deleted:

• You can still retrieve the template by calling GetTemplate.

• You cannot update the template.

• You cannot create a case by using the deleted template.

• Deleted templates are not included in the ListTemplates response.

This is a convenience which creates an instance of the DeleteTemplateRequest.Builder avoiding the need to create one manually via DeleteTemplateRequest.builder()

Parameters:

deleteTemplateRequest - A Consumer that will call methods on DeleteTemplateRequest.Builder to create a request.

Returns:

Result of the DeleteTemplate operation returned by the service.

See Also:

• AWS API Documentation

getCase

default GetCaseResponse getCase(GetCaseRequest getCaseRequest)
                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns information about a specific case if it exists.

Parameters:

getCaseRequest -

Returns:

Result of the GetCase operation returned by the service.

See Also:

• AWS API Documentation

getCase

default GetCaseResponse getCase(Consumer<GetCaseRequest.Builder> getCaseRequest)
                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns information about a specific case if it exists.

This is a convenience which creates an instance of the GetCaseRequest.Builder avoiding the need to create one manually via GetCaseRequest.builder()

Parameters:

getCaseRequest - A Consumer that will call methods on GetCaseRequest.Builder to create a request.

Returns:

Result of the GetCase operation returned by the service.

See Also:

• AWS API Documentation

getCasePaginator

default GetCaseIterable getCasePaginator(GetCaseRequest getCaseRequest)
                                  throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.GetCaseResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation.

Parameters:

getCaseRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getCasePaginator

default GetCaseIterable getCasePaginator(Consumer<GetCaseRequest.Builder> getCaseRequest)
                                  throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.GetCaseResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation.

This is a convenience which creates an instance of the GetCaseRequest.Builder avoiding the need to create one manually via GetCaseRequest.builder()

Parameters:

getCaseRequest - A Consumer that will call methods on GetCaseRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getCaseAuditEvents

default GetCaseAuditEventsResponse getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the audit history about a specific case if it exists.

Parameters:

getCaseAuditEventsRequest -

Returns:

Result of the GetCaseAuditEvents operation returned by the service.

See Also:

• AWS API Documentation

getCaseAuditEvents

default GetCaseAuditEventsResponse getCaseAuditEvents(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the audit history about a specific case if it exists.

This is a convenience which creates an instance of the GetCaseAuditEventsRequest.Builder avoiding the need to create one manually via GetCaseAuditEventsRequest.builder()

Parameters:

getCaseAuditEventsRequest - A Consumer that will call methods on GetCaseAuditEventsRequest.Builder to create a request.

Returns:

Result of the GetCaseAuditEvents operation returned by the service.

See Also:

• AWS API Documentation

getCaseAuditEventsPaginator

default GetCaseAuditEventsIterable getCaseAuditEventsPaginator(GetCaseAuditEventsRequest getCaseAuditEventsRequest)
                                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client
             .getCaseAuditEventsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation.

Parameters:

getCaseAuditEventsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getCaseAuditEventsPaginator

default GetCaseAuditEventsIterable getCaseAuditEventsPaginator(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)
                                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client
             .getCaseAuditEventsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation.

This is a convenience which creates an instance of the GetCaseAuditEventsRequest.Builder avoiding the need to create one manually via GetCaseAuditEventsRequest.builder()

Parameters:

getCaseAuditEventsRequest - A Consumer that will call methods on GetCaseAuditEventsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getCaseEventConfiguration

default GetCaseEventConfigurationResponse getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)
                                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the case event publishing configuration.

Parameters:

getCaseEventConfigurationRequest -

Returns:

Result of the GetCaseEventConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getCaseEventConfiguration

default GetCaseEventConfigurationResponse getCaseEventConfiguration(Consumer<GetCaseEventConfigurationRequest.Builder> getCaseEventConfigurationRequest)
                                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the case event publishing configuration.

This is a convenience which creates an instance of the GetCaseEventConfigurationRequest.Builder avoiding the need to create one manually via GetCaseEventConfigurationRequest.builder()

Parameters:

getCaseEventConfigurationRequest - A Consumer that will call methods on GetCaseEventConfigurationRequest.Builder to create a request.

Returns:

Result of the GetCaseEventConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(GetDomainRequest getDomainRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns information about a specific domain if it exists.

Parameters:

getDomainRequest -

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns information about a specific domain if it exists.

This is a convenience which creates an instance of the GetDomainRequest.Builder avoiding the need to create one manually via GetDomainRequest.builder()

Parameters:

getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getLayout

default GetLayoutResponse getLayout(GetLayoutRequest getLayoutRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the details for the requested layout.

Parameters:

getLayoutRequest -

Returns:

Result of the GetLayout operation returned by the service.

See Also:

• AWS API Documentation

getLayout

default GetLayoutResponse getLayout(Consumer<GetLayoutRequest.Builder> getLayoutRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the details for the requested layout.

This is a convenience which creates an instance of the GetLayoutRequest.Builder avoiding the need to create one manually via GetLayoutRequest.builder()

Parameters:

getLayoutRequest - A Consumer that will call methods on GetLayoutRequest.Builder to create a request.

Returns:

Result of the GetLayout operation returned by the service.

See Also:

• AWS API Documentation

getMergeCasesStatus

default GetMergeCasesStatusResponse getMergeCasesStatus(GetMergeCasesStatusRequest getMergeCasesStatusRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the merge status of a case. Use this operation to track a merge that you started with StartMergeCases, or to check whether a case is part of a merge before you modify it.

The operation returns the following, depending on the case:

• For the primary case or the secondary case of a merge that is running, it returns IN_PROGRESS.

• For a case that was merged into another case as the secondary case, it returns COMPLETED.

• For any other case, it returns a ResourceNotFoundException. This includes the primary case after its merge finishes.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

getMergeCasesStatusRequest -

Returns:

Result of the GetMergeCasesStatus operation returned by the service.

See Also:

• AWS API Documentation

getMergeCasesStatus

default GetMergeCasesStatusResponse getMergeCasesStatus(Consumer<GetMergeCasesStatusRequest.Builder> getMergeCasesStatusRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the merge status of a case. Use this operation to track a merge that you started with StartMergeCases, or to check whether a case is part of a merge before you modify it.

The operation returns the following, depending on the case:

• For the primary case or the secondary case of a merge that is running, it returns IN_PROGRESS.

• For a case that was merged into another case as the secondary case, it returns COMPLETED.

• For any other case, it returns a ResourceNotFoundException. This includes the primary case after its merge finishes.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the GetMergeCasesStatusRequest.Builder avoiding the need to create one manually via GetMergeCasesStatusRequest.builder()

Parameters:

getMergeCasesStatusRequest - A Consumer that will call methods on GetMergeCasesStatusRequest.Builder to create a request.

Returns:

Result of the GetMergeCasesStatus operation returned by the service.

See Also:

• AWS API Documentation

getTemplate

default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the details for the requested template. Other template APIs are:

• CreateTemplate

• DeleteTemplate

• ListTemplates

• UpdateTemplate

Parameters:

getTemplateRequest -

Returns:

Result of the GetTemplate operation returned by the service.

See Also:

• AWS API Documentation

getTemplate

default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Returns the details for the requested template. Other template APIs are:

• CreateTemplate

• DeleteTemplate

• ListTemplates

• UpdateTemplate

This is a convenience which creates an instance of the GetTemplateRequest.Builder avoiding the need to create one manually via GetTemplateRequest.builder()

Parameters:

getTemplateRequest - A Consumer that will call methods on GetTemplateRequest.Builder to create a request.

Returns:

Result of the GetTemplate operation returned by the service.

See Also:

• AWS API Documentation

listCaseRules

default ListCaseRulesResponse listCaseRules(ListCaseRulesRequest listCaseRulesRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all case rules in a Cases domain. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

listCaseRulesRequest -

Returns:

Result of the ListCaseRules operation returned by the service.

See Also:

• AWS API Documentation

listCaseRules

default ListCaseRulesResponse listCaseRules(Consumer<ListCaseRulesRequest.Builder> listCaseRulesRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all case rules in a Cases domain. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

This is a convenience which creates an instance of the ListCaseRulesRequest.Builder avoiding the need to create one manually via ListCaseRulesRequest.builder()

Parameters:

listCaseRulesRequest - A Consumer that will call methods on ListCaseRulesRequest.Builder to create a request.

Returns:

Result of the ListCaseRules operation returned by the service.

See Also:

• AWS API Documentation

listCaseRulesPaginator

default ListCaseRulesIterable listCaseRulesPaginator(ListCaseRulesRequest listCaseRulesRequest)
                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client.listCaseRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client
             .listCaseRulesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListCaseRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client.listCaseRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation.

Parameters:

listCaseRulesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCaseRulesPaginator

default ListCaseRulesIterable listCaseRulesPaginator(Consumer<ListCaseRulesRequest.Builder> listCaseRulesRequest)
                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client.listCaseRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client
             .listCaseRulesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListCaseRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListCaseRulesIterable responses = client.listCaseRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCaseRules(software.amazon.awssdk.services.connectcases.model.ListCaseRulesRequest) operation.

This is a convenience which creates an instance of the ListCaseRulesRequest.Builder avoiding the need to create one manually via ListCaseRulesRequest.builder()

Parameters:

listCaseRulesRequest - A Consumer that will call methods on ListCaseRulesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCasesForContact

default ListCasesForContactResponse listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists cases for a given contact.

Parameters:

listCasesForContactRequest -

Returns:

Result of the ListCasesForContact operation returned by the service.

See Also:

• AWS API Documentation

listCasesForContact

default ListCasesForContactResponse listCasesForContact(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists cases for a given contact.

This is a convenience which creates an instance of the ListCasesForContactRequest.Builder avoiding the need to create one manually via ListCasesForContactRequest.builder()

Parameters:

listCasesForContactRequest - A Consumer that will call methods on ListCasesForContactRequest.Builder to create a request.

Returns:

Result of the ListCasesForContact operation returned by the service.

See Also:

• AWS API Documentation

listCasesForContactPaginator

default ListCasesForContactIterable listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest)
                                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client
             .listCasesForContactPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation.

Parameters:

listCasesForContactRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCasesForContactPaginator

default ListCasesForContactIterable listCasesForContactPaginator(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)
                                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client
             .listCasesForContactPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation.

This is a convenience which creates an instance of the ListCasesForContactRequest.Builder avoiding the need to create one manually via ListCasesForContactRequest.builder()

Parameters:

listCasesForContactRequest - A Consumer that will call methods on ListCasesForContactRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest)
                                 throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                 throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest)
                                          throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation.

Parameters:

listDomainsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                          throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation.

This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFieldOptions

default ListFieldOptionsResponse listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all of the field options for a field identifier in the domain.

Parameters:

listFieldOptionsRequest -

Returns:

Result of the ListFieldOptions operation returned by the service.

See Also:

• AWS API Documentation

listFieldOptions

default ListFieldOptionsResponse listFieldOptions(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all of the field options for a field identifier in the domain.

This is a convenience which creates an instance of the ListFieldOptionsRequest.Builder avoiding the need to create one manually via ListFieldOptionsRequest.builder()

Parameters:

listFieldOptionsRequest - A Consumer that will call methods on ListFieldOptionsRequest.Builder to create a request.

Returns:

Result of the ListFieldOptions operation returned by the service.

See Also:

• AWS API Documentation

listFieldOptionsPaginator

default ListFieldOptionsIterable listFieldOptionsPaginator(ListFieldOptionsRequest listFieldOptionsRequest)
                                                    throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client
             .listFieldOptionsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation.

Parameters:

listFieldOptionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFieldOptionsPaginator

default ListFieldOptionsIterable listFieldOptionsPaginator(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)
                                                    throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client
             .listFieldOptionsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation.

This is a convenience which creates an instance of the ListFieldOptionsRequest.Builder avoiding the need to create one manually via ListFieldOptionsRequest.builder()

Parameters:

listFieldOptionsRequest - A Consumer that will call methods on ListFieldOptionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFields

default ListFieldsResponse listFields(ListFieldsRequest listFieldsRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all fields in a Cases domain.

Parameters:

listFieldsRequest -

Returns:

Result of the ListFields operation returned by the service.

See Also:

• AWS API Documentation

listFields

default ListFieldsResponse listFields(Consumer<ListFieldsRequest.Builder> listFieldsRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all fields in a Cases domain.

This is a convenience which creates an instance of the ListFieldsRequest.Builder avoiding the need to create one manually via ListFieldsRequest.builder()

Parameters:

listFieldsRequest - A Consumer that will call methods on ListFieldsRequest.Builder to create a request.

Returns:

Result of the ListFields operation returned by the service.

See Also:

• AWS API Documentation

listFieldsPaginator

default ListFieldsIterable listFieldsPaginator(ListFieldsRequest listFieldsRequest)
                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListFieldsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation.

Parameters:

listFieldsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFieldsPaginator

default ListFieldsIterable listFieldsPaginator(Consumer<ListFieldsRequest.Builder> listFieldsRequest)
                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListFieldsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation.

This is a convenience which creates an instance of the ListFieldsRequest.Builder avoiding the need to create one manually via ListFieldsRequest.builder()

Parameters:

listFieldsRequest - A Consumer that will call methods on ListFieldsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLayouts

default ListLayoutsResponse listLayouts(ListLayoutsRequest listLayoutsRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Parameters:

listLayoutsRequest -

Returns:

Result of the ListLayouts operation returned by the service.

See Also:

• AWS API Documentation

listLayouts

default ListLayoutsResponse listLayouts(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

This is a convenience which creates an instance of the ListLayoutsRequest.Builder avoiding the need to create one manually via ListLayoutsRequest.builder()

Parameters:

listLayoutsRequest - A Consumer that will call methods on ListLayoutsRequest.Builder to create a request.

Returns:

Result of the ListLayouts operation returned by the service.

See Also:

• AWS API Documentation

listLayoutsPaginator

default ListLayoutsIterable listLayoutsPaginator(ListLayoutsRequest listLayoutsRequest)
                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation.

Parameters:

listLayoutsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLayoutsPaginator

default ListLayoutsIterable listLayoutsPaginator(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)
                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation.

This is a convenience which creates an instance of the ListLayoutsRequest.Builder avoiding the need to create one manually via ListLayoutsRequest.builder()

Parameters:

listLayoutsRequest - A Consumer that will call methods on ListLayoutsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists tags for a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTemplates

default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Other template APIs are:

• CreateTemplate

• DeleteTemplate

• GetTemplate

• UpdateTemplate

Parameters:

listTemplatesRequest -

Returns:

Result of the ListTemplates operation returned by the service.

See Also:

• AWS API Documentation

listTemplates

default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Other template APIs are:

• CreateTemplate

• DeleteTemplate

• GetTemplate

• UpdateTemplate

This is a convenience which creates an instance of the ListTemplatesRequest.Builder avoiding the need to create one manually via ListTemplatesRequest.builder()

Parameters:

listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.

Returns:

Result of the ListTemplates operation returned by the service.

See Also:

• AWS API Documentation

listTemplatesPaginator

default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client
             .listTemplatesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation.

Parameters:

listTemplatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplatesPaginator

default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client
             .listTemplatesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation.

This is a convenience which creates an instance of the ListTemplatesRequest.Builder avoiding the need to create one manually via ListTemplatesRequest.builder()

Parameters:

listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putCaseEventConfiguration

default PutCaseEventConfigurationResponse putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)
                                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Connect Customer Administrator Guide.

Parameters:

putCaseEventConfigurationRequest -

Returns:

Result of the PutCaseEventConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putCaseEventConfiguration

default PutCaseEventConfigurationResponse putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest)
                                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Connect Customer Administrator Guide.

This is a convenience which creates an instance of the PutCaseEventConfigurationRequest.Builder avoiding the need to create one manually via PutCaseEventConfigurationRequest.builder()

Parameters:

putCaseEventConfigurationRequest - A Consumer that will call methods on PutCaseEventConfigurationRequest.Builder to create a request.

Returns:

Result of the PutCaseEventConfiguration operation returned by the service.

See Also:

• AWS API Documentation

searchAllRelatedItems

default SearchAllRelatedItemsResponse searchAllRelatedItems(SearchAllRelatedItemsRequest searchAllRelatedItemsRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API.

Use cases

Following are common uses cases for this API:

• Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions.

• Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey.

• Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts.

Important things to know

• This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID.

• This API searches across related items content, not case fields. Use the SearchCases API to search within case field values.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

searchAllRelatedItemsRequest -

Returns:

Result of the SearchAllRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

searchAllRelatedItems

default SearchAllRelatedItemsResponse searchAllRelatedItems(Consumer<SearchAllRelatedItemsRequest.Builder> searchAllRelatedItemsRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API.

Use cases

Following are common uses cases for this API:

• Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions.

• Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey.

• Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts.

Important things to know

• This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID.

• This API searches across related items content, not case fields. Use the SearchCases API to search within case field values.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the SearchAllRelatedItemsRequest.Builder avoiding the need to create one manually via SearchAllRelatedItemsRequest.builder()

Parameters:

searchAllRelatedItemsRequest - A Consumer that will call methods on SearchAllRelatedItemsRequest.Builder to create a request.

Returns:

Result of the SearchAllRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

searchAllRelatedItemsPaginator

default SearchAllRelatedItemsIterable searchAllRelatedItemsPaginator(SearchAllRelatedItemsRequest searchAllRelatedItemsRequest)
                                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client.searchAllRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client
             .searchAllRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client.searchAllRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation.

Parameters:

searchAllRelatedItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchAllRelatedItemsPaginator

default SearchAllRelatedItemsIterable searchAllRelatedItemsPaginator(Consumer<SearchAllRelatedItemsRequest.Builder> searchAllRelatedItemsRequest)
                                                              throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client.searchAllRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client
             .searchAllRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchAllRelatedItemsIterable responses = client.searchAllRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchAllRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchAllRelatedItemsRequest) operation.

This is a convenience which creates an instance of the SearchAllRelatedItemsRequest.Builder avoiding the need to create one manually via SearchAllRelatedItemsRequest.builder()

Parameters:

searchAllRelatedItemsRequest - A Consumer that will call methods on SearchAllRelatedItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchCases

default SearchCasesResponse searchCases(SearchCasesRequest searchCasesRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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 .

Parameters:

searchCasesRequest -

Returns:

Result of the SearchCases operation returned by the service.

See Also:

• AWS API Documentation

searchCases

default SearchCasesResponse searchCases(Consumer<SearchCasesRequest.Builder> searchCasesRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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 .

This is a convenience which creates an instance of the SearchCasesRequest.Builder avoiding the need to create one manually via SearchCasesRequest.builder()

Parameters:

searchCasesRequest - A Consumer that will call methods on SearchCasesRequest.Builder to create a request.

Returns:

Result of the SearchCases operation returned by the service.

See Also:

• AWS API Documentation

searchCasesPaginator

default SearchCasesIterable searchCasesPaginator(SearchCasesRequest searchCasesRequest)
                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation.

Parameters:

searchCasesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchCasesPaginator

default SearchCasesIterable searchCasesPaginator(Consumer<SearchCasesRequest.Builder> searchCasesRequest)
                                          throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation.

This is a convenience which creates an instance of the SearchCasesRequest.Builder avoiding the need to create one manually via SearchCasesRequest.builder()

Parameters:

searchCasesRequest - A Consumer that will call methods on SearchCasesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchRelatedItems

default SearchRelatedItemsResponse searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

Parameters:

searchRelatedItemsRequest -

Returns:

Result of the SearchRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

searchRelatedItems

default SearchRelatedItemsResponse searchRelatedItems(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

This is a convenience which creates an instance of the SearchRelatedItemsRequest.Builder avoiding the need to create one manually via SearchRelatedItemsRequest.builder()

Parameters:

searchRelatedItemsRequest - A Consumer that will call methods on SearchRelatedItemsRequest.Builder to create a request.

Returns:

Result of the SearchRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

searchRelatedItemsPaginator

default SearchRelatedItemsIterable searchRelatedItemsPaginator(SearchRelatedItemsRequest searchRelatedItemsRequest)
                                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client
             .searchRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation.

Parameters:

searchRelatedItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchRelatedItemsPaginator

default SearchRelatedItemsIterable searchRelatedItemsPaginator(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)
                                                        throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client
             .searchRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation.

This is a convenience which creates an instance of the SearchRelatedItemsRequest.Builder avoiding the need to create one manually via SearchRelatedItemsRequest.builder()

Parameters:

searchRelatedItemsRequest - A Consumer that will call methods on SearchRelatedItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

startMergeCases

default StartMergeCasesResponse startMergeCases(StartMergeCasesRequest startMergeCasesRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Merges a secondary case into a primary case. The primary case, which you specify in the request URI, remains active. Both cases must belong to the same domain.

The merge runs asynchronously. To track its progress, call GetMergeCasesStatus. When the merge finishes, the selected field values and related items from the secondary case are on the primary case, the two cases are linked, and the secondary case is closed. Both cases record the merge in their audit history. For more information, see GetCaseAuditEvents.

Important things to know

• Both cases must have the same customer, or at least one of them must have no customer.

• While the merge runs, you can't modify the secondary case or its related items, and you can't delete the primary case. These requests return a ConflictException.

• After the merge, the secondary case can be reopened, updated, and deleted, but it can't be merged again.

The request fails with a ValidationException, and no merge starts, if:

• The primary case and the secondary case are the same case.

• Either case is closed.

• Both cases have a customer, and the customers are different.

• fieldsConfiguration selects a field that can't be merged, or a field that the secondary case doesn't have.

• After the merge, the primary case would have more than 500 field values, or would exceed the maximum case size.

The request fails with a ServiceQuotaExceededException if, after the merge, either case would exceed the quota for related items per case. For the primary case, the count is its existing related items, plus the related items moved from the secondary case, plus the new case link. See Connect Customer Cases quotas.

The request fails with a ConflictException if either case is already part of a merge that is running, or was previously merged into another case as the secondary case.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

startMergeCasesRequest -

Returns:

Result of the StartMergeCases operation returned by the service.

See Also:

• AWS API Documentation

startMergeCases

default StartMergeCasesResponse startMergeCases(Consumer<StartMergeCasesRequest.Builder> startMergeCasesRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Merges a secondary case into a primary case. The primary case, which you specify in the request URI, remains active. Both cases must belong to the same domain.

The merge runs asynchronously. To track its progress, call GetMergeCasesStatus. When the merge finishes, the selected field values and related items from the secondary case are on the primary case, the two cases are linked, and the secondary case is closed. Both cases record the merge in their audit history. For more information, see GetCaseAuditEvents.

Important things to know

• Both cases must have the same customer, or at least one of them must have no customer.

• While the merge runs, you can't modify the secondary case or its related items, and you can't delete the primary case. These requests return a ConflictException.

• After the merge, the secondary case can be reopened, updated, and deleted, but it can't be merged again.

The request fails with a ValidationException, and no merge starts, if:

• The primary case and the secondary case are the same case.

• Either case is closed.

• Both cases have a customer, and the customers are different.

• fieldsConfiguration selects a field that can't be merged, or a field that the secondary case doesn't have.

• After the merge, the primary case would have more than 500 field values, or would exceed the maximum case size.

The request fails with a ServiceQuotaExceededException if, after the merge, either case would exceed the quota for related items per case. For the primary case, the count is its existing related items, plus the related items moved from the secondary case, plus the new case link. See Connect Customer Cases quotas.

The request fails with a ConflictException if either case is already part of a merge that is running, or was previously merged into another case as the secondary case.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the StartMergeCasesRequest.Builder avoiding the need to create one manually via StartMergeCasesRequest.builder()

Parameters:

startMergeCasesRequest - A Consumer that will call methods on StartMergeCasesRequest.Builder to create a request.

Returns:

Result of the StartMergeCases operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Adds tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Adds tags to a resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Untags a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Untags a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCase

default UpdateCaseResponse updateCase(UpdateCaseRequest updateCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN that you provide.

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input.

If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Parameters:

updateCaseRequest -

Returns:

Result of the UpdateCase operation returned by the service.

See Also:

• AWS API Documentation

updateCase

default UpdateCaseResponse updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN that you provide.

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input.

If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

This is a convenience which creates an instance of the UpdateCaseRequest.Builder avoiding the need to create one manually via UpdateCaseRequest.builder()

Parameters:

updateCaseRequest - A Consumer that will call methods on UpdateCaseRequest.Builder to create a request.

Returns:

Result of the UpdateCase operation returned by the service.

See Also:

• AWS API Documentation

updateCaseRule

default UpdateCaseRuleResponse updateCaseRule(UpdateCaseRuleRequest updateCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates a case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

updateCaseRuleRequest -

Returns:

Result of the UpdateCaseRule operation returned by the service.

See Also:

• AWS API Documentation

updateCaseRule

default UpdateCaseRuleResponse updateCaseRule(Consumer<UpdateCaseRuleRequest.Builder> updateCaseRuleRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates a case rule. In the Connect Customer admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

This is a convenience which creates an instance of the UpdateCaseRuleRequest.Builder avoiding the need to create one manually via UpdateCaseRuleRequest.builder()

Parameters:

updateCaseRuleRequest - A Consumer that will call methods on UpdateCaseRuleRequest.Builder to create a request.

Returns:

Result of the UpdateCaseRule operation returned by the service.

See Also:

• AWS API Documentation

updateField

default UpdateFieldResponse updateField(UpdateFieldRequest updateFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates the properties of an existing field.

Parameters:

updateFieldRequest -

Returns:

Result of the UpdateField operation returned by the service.

See Also:

• AWS API Documentation

updateField

default UpdateFieldResponse updateField(Consumer<UpdateFieldRequest.Builder> updateFieldRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates the properties of an existing field.

This is a convenience which creates an instance of the UpdateFieldRequest.Builder avoiding the need to create one manually via UpdateFieldRequest.builder()

Parameters:

updateFieldRequest - A Consumer that will call methods on UpdateFieldRequest.Builder to create a request.

Returns:

Result of the UpdateField operation returned by the service.

See Also:

• AWS API Documentation

updateLayout

default UpdateLayoutResponse updateLayout(UpdateLayoutRequest updateLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Parameters:

updateLayoutRequest -

Returns:

Result of the UpdateLayout operation returned by the service.

See Also:

• AWS API Documentation

updateLayout

default UpdateLayoutResponse updateLayout(Consumer<UpdateLayoutRequest.Builder> updateLayoutRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

This is a convenience which creates an instance of the UpdateLayoutRequest.Builder avoiding the need to create one manually via UpdateLayoutRequest.builder()

Parameters:

updateLayoutRequest - A Consumer that will call methods on UpdateLayoutRequest.Builder to create a request.

Returns:

Result of the UpdateLayout operation returned by the service.

See Also:

• AWS API Documentation

updateRelatedItem

default UpdateRelatedItemResponse updateRelatedItem(UpdateRelatedItemRequest updateRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates the content of a related item associated with a case. The following related item types are supported:

• Comment - Update the text content of an existing comment

• Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

Important things to know

• When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.

• If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

• System case fields cannot be used in a custom related item.

• If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Endpoints: See Connect Customer endpoints and quotas.

Parameters:

updateRelatedItemRequest -

Returns:

Result of the UpdateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

updateRelatedItem

default UpdateRelatedItemResponse updateRelatedItem(Consumer<UpdateRelatedItemRequest.Builder> updateRelatedItemRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

Updates the content of a related item associated with a case. The following related item types are supported:

• Comment - Update the text content of an existing comment

• Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

Important things to know

• When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.

• If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

• System case fields cannot be used in a custom related item.

• If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Endpoints: See Connect Customer endpoints and quotas.

This is a convenience which creates an instance of the UpdateRelatedItemRequest.Builder avoiding the need to create one manually via UpdateRelatedItemRequest.builder()

Parameters:

updateRelatedItemRequest - A Consumer that will call methods on UpdateRelatedItemRequest.Builder to create a request.

Returns:

Result of the UpdateRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

updateTemplate

default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Other template APIs are:

• CreateTemplate

• DeleteTemplate

• GetTemplate

• ListTemplates

Parameters:

updateTemplateRequest -

Returns:

Result of the UpdateTemplate operation returned by the service.

See Also:

• AWS API Documentation

updateTemplate

default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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.

Other template APIs are:

• CreateTemplate

• DeleteTemplate

• GetTemplate

• ListTemplates

This is a convenience which creates an instance of the UpdateTemplateRequest.Builder avoiding the need to create one manually via UpdateTemplateRequest.builder()

Parameters:

updateTemplateRequest - A Consumer that will call methods on UpdateTemplateRequest.Builder to create a request.

Returns:

Result of the UpdateTemplate operation returned by the service.

See Also:

• AWS API Documentation

create

static ConnectCasesClient create()

Create a ConnectCasesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ConnectCasesClientBuilder builder()

Create a builder that can be used to configure and create a ConnectCasesClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ConnectCasesServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration