Interface ConnectCasesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.

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

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

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 connect:DescribeUser permission on the User ARN resource that you provide

  <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> 
 

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 connect:DescribeUser permission on the User ARN resource that you provide

  <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> 
 

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

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 Amazon Connect instance can be associated with only one Cases domain.

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

  </important> 
 

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 Amazon Connect instance can be associated with only one Cases domain.

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

  </important> 
 

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,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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

• A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

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

  </note> 
 

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,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectCasesException

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

• A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

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

  </note> 
 

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.

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.

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

deleteDomain

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

Deletes a Cases domain.

  <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note> 
 

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.

  <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note> 
 

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. You can delete up to 100 fields per domain.

After a field is deleted:

• You can still retrieve the field by calling BatchGetField.

• You cannot update a deleted field by calling UpdateField; it throws a ValidationException.

• Deleted fields are not included in the ListFields response.

• Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.

• Calling GetCase with a deleted field ID returns the deleted field's value if one exists.

• Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.

• GetTemplate does not return field IDs for deleted fields.

• GetLayout does not return field IDs for deleted fields.

• Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.

• Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.

• Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.

• Calling GetCaseEventConfiguration does not return field IDs for deleted fields.

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. You can delete up to 100 fields per domain.

After a field is deleted:

• You can still retrieve the field by calling BatchGetField.

• You cannot update a deleted field by calling UpdateField; it throws a ValidationException.

• Deleted fields are not included in the ListFields response.

• Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.

• Calling GetCase with a deleted field ID returns the deleted field's value if one exists.

• Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.

• GetTemplate does not return field IDs for deleted fields.

• GetLayout does not return field IDs for deleted fields.

• Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.

• Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.

• Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.

• Calling GetCaseEventConfiguration does not return field IDs for deleted fields.

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.

  <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul> 
 

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.

  <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul> 
 

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

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.

  <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul> 
 

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.

  <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul> 
 

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

getTemplate

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

Returns the details for the requested template.

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.

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

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.

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.

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,
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 Amazon Connect 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,
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 Amazon Connect 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

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

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,
AwsServiceException,
SdkClientException,
ConnectCasesException

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

  <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> 
 

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,
AwsServiceException,
SdkClientException,
ConnectCasesException

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

  <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> 
 

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

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

updateTemplate

default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
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.

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

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