@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCasesClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGetFieldResponse |
batchGetField(BatchGetFieldRequest batchGetFieldRequest)
Returns the description for the list of fields in the request parameters.
|
default BatchGetFieldResponse |
batchGetField(Consumer<BatchGetFieldRequest.Builder> batchGetFieldRequest)
Returns the description for the list of fields in the request parameters.
|
default BatchPutFieldOptionsResponse |
batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)
Creates and updates a set of field options for a single select field in a Cases domain.
|
default BatchPutFieldOptionsResponse |
batchPutFieldOptions(Consumer<BatchPutFieldOptionsRequest.Builder> 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)
Creates a case in the specified Cases domain.
|
default CreateCaseResponse |
createCase(CreateCaseRequest createCaseRequest)
Creates a case in the specified Cases domain.
|
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 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 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)
Returns information about a specific case if it exists.
|
default GetCaseIterable |
getCasePaginator(GetCaseRequest getCaseRequest)
Returns information about a specific case if it exists.
|
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)
Lists cases for a given contact.
|
default ListCasesForContactIterable |
listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest)
Lists cases for a given contact.
|
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)
Lists all cases domains in the Amazon Web Services account.
|
default ListDomainsIterable |
listDomainsPaginator(ListDomainsRequest listDomainsRequest)
Lists all cases domains in the Amazon Web Services account.
|
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)
Lists all of the field options for a field identifier in the domain.
|
default ListFieldOptionsIterable |
listFieldOptionsPaginator(ListFieldOptionsRequest listFieldOptionsRequest)
Lists all of the field options for a field identifier in the domain.
|
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)
Lists all fields in a Cases domain.
|
default ListFieldsIterable |
listFieldsPaginator(ListFieldsRequest listFieldsRequest)
Lists all fields in a Cases domain.
|
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)
Lists all layouts in the given cases domain.
|
default ListLayoutsIterable |
listLayoutsPaginator(ListLayoutsRequest listLayoutsRequest)
Lists all layouts in the given cases domain.
|
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)
Lists all of the templates in a Cases domain.
|
default ListTemplatesIterable |
listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
Lists all of the templates in a Cases domain.
|
default PutCaseEventConfigurationResponse |
putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest)
API for adding case event publishing configuration
|
default PutCaseEventConfigurationResponse |
putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)
API for adding 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)
Searches for cases within their associated Cases domain.
|
default SearchCasesIterable |
searchCasesPaginator(SearchCasesRequest searchCasesRequest)
Searches for cases within their associated Cases domain.
|
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)
Searches for related items that are associated with a case.
|
default SearchRelatedItemsIterable |
searchRelatedItemsPaginator(SearchRelatedItemsRequest searchRelatedItemsRequest)
Searches for related items that are associated with a case.
|
default ConnectCasesServiceClientConfiguration |
serviceClientConfiguration() |
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)
Updates the values of fields on a case.
|
default UpdateCaseResponse |
updateCase(UpdateCaseRequest updateCaseRequest)
Updates the values of fields on a case.
|
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
batchGetFieldRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
batchGetFieldRequest - A Consumer that will call methods on
BatchGetFieldRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
batchPutFieldOptionsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
batchPutFieldOptionsRequest - A Consumer that will call methods on
BatchPutFieldOptionsRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCaseResponse createCase(CreateCaseRequest createCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
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.
The following fields are required when creating a case:
<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/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>
createCaseRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
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.
The following fields are required when creating a case:
<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/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>
This is a convenience which creates an instance of the CreateCaseRequest.Builder avoiding the need to
create one manually via CreateCaseRequest.builder()
createCaseRequest - A Consumer that will call methods on
CreateCaseRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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>
createDomainRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createDomainRequest - A Consumer that will call methods on
CreateDomainRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createFieldRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createFieldRequest - A Consumer that will call methods on
CreateFieldRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createLayoutRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createLayoutRequest - A Consumer that will call methods on
CreateLayoutRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createRelatedItemRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the CreateRelatedItemRequest.Builder avoiding the need
to create one manually via CreateRelatedItemRequest.builder()
createRelatedItemRequest - A Consumer that will call methods on
CreateRelatedItemRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createTemplateRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createTemplateRequest - A Consumer that will call methods on
CreateTemplateRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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>
deleteDomainRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteDomainRequest - A Consumer that will call methods on
DeleteDomainRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCaseResponse getCase(GetCaseRequest getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific case if it exists.
getCaseRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getCaseRequest - A Consumer that will call methods on
GetCaseRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCaseIterable getCasePaginator(GetCaseRequest getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific case if it exists.
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.
getCaseRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCaseIterable getCasePaginator(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 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()
getCaseRequest - A Consumer that will call methods on
GetCaseRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCaseEventConfigurationResponse getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the case event publishing configuration.
getCaseEventConfigurationRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getCaseEventConfigurationRequest - A Consumer that will call methods on
GetCaseEventConfigurationRequest.Builder to
create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific domain if it exists.
getDomainRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getDomainRequest - A Consumer that will call methods on
GetDomainRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLayoutResponse getLayout(GetLayoutRequest getLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested layout.
getLayoutRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getLayoutRequest - A Consumer that will call methods on
GetLayoutRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested template.
getTemplateRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getTemplateRequest - A Consumer that will call methods on
GetTemplateRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCasesForContactResponse listCasesForContact(ListCasesForContactRequest listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists cases for a given contact.
listCasesForContactRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listCasesForContactRequest - A Consumer that will call methods on
ListCasesForContactRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCasesForContactIterable listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists cases for a given contact.
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.
listCasesForContactRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCasesForContactIterable listCasesForContactPaginator(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists cases for a given contact.
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()
listCasesForContactRequest - A Consumer that will call methods on
ListCasesForContactRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDomainsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listDomainsRequest - A Consumer that will call methods on
ListDomainsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainsIterable listDomainsPaginator(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.
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.
listDomainsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainsIterable listDomainsPaginator(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 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()
listDomainsRequest - A Consumer that will call methods on
ListDomainsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listFieldOptionsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listFieldOptionsRequest - A Consumer that will call methods on
ListFieldOptionsRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFieldOptionsIterable listFieldOptionsPaginator(ListFieldOptionsRequest 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 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.
listFieldOptionsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFieldOptionsIterable listFieldOptionsPaginator(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 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()
listFieldOptionsRequest - A Consumer that will call methods on
ListFieldOptionsRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFieldsResponse listFields(ListFieldsRequest listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all fields in a Cases domain.
listFieldsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listFieldsRequest - A Consumer that will call methods on
ListFieldsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFieldsIterable listFieldsPaginator(ListFieldsRequest listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all fields in a Cases domain.
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.
listFieldsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFieldsIterable listFieldsPaginator(Consumer<ListFieldsRequest.Builder> listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all fields in a Cases domain.
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()
listFieldsRequest - A Consumer that will call methods on
ListFieldsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listLayoutsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listLayoutsRequest - A Consumer that will call methods on
ListLayoutsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLayoutsIterable listLayoutsPaginator(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.
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.
listLayoutsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLayoutsIterable listLayoutsPaginator(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 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()
listLayoutsRequest - A Consumer that will call methods on
ListLayoutsRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists tags for a resource.
listTagsForResourceRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTemplatesRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listTemplatesRequest - A Consumer that will call methods on
ListTemplatesRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTemplatesIterable listTemplatesPaginator(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.
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.
listTemplatesRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTemplatesIterable listTemplatesPaginator(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 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()
listTemplatesRequest - A Consumer that will call methods on
ListTemplatesRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutCaseEventConfigurationResponse putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
API for adding case event publishing configuration
putCaseEventConfigurationRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutCaseEventConfigurationResponse putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
API for adding case event publishing configuration
This is a convenience which creates an instance of the PutCaseEventConfigurationRequest.Builder avoiding
the need to create one manually via PutCaseEventConfigurationRequest.builder()
putCaseEventConfigurationRequest - A Consumer that will call methods on
PutCaseEventConfigurationRequest.Builder to
create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
.
searchCasesRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
searchCasesRequest - A Consumer that will call methods on
SearchCasesRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchCasesIterable searchCasesPaginator(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
.
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.
searchCasesRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchCasesIterable searchCasesPaginator(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 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()
searchCasesRequest - A Consumer that will call methods on
SearchCasesRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
searchRelatedItemsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
searchRelatedItemsRequest - A Consumer that will call methods on
SearchRelatedItemsRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRelatedItemsIterable searchRelatedItemsPaginator(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.
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.
searchRelatedItemsRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRelatedItemsIterable searchRelatedItemsPaginator(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 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()
searchRelatedItemsRequest - A Consumer that will call methods on
SearchRelatedItemsRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Adds tags to a resource.
tagResourceRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Untags a resource.
untagResourceRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCaseResponse updateCase(UpdateCaseRequest updateCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical
to the CreateCase input .
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
updateCaseRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCaseResponse updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical
to the CreateCase input .
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the UpdateCaseRequest.Builder avoiding the need to
create one manually via UpdateCaseRequest.builder()
updateCaseRequest - A Consumer that will call methods on
UpdateCaseRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFieldResponse updateField(UpdateFieldRequest updateFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the properties of an existing field.
updateFieldRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateFieldRequest - A Consumer that will call methods on
UpdateFieldRequest.Builder to create a request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateLayoutRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateLayoutRequest - A Consumer that will call methods on
UpdateLayoutRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon
Connect Service Quotas in the Amazon Connect Administrator Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateTemplateRequest - InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateTemplateRequest - A Consumer that will call methods on
UpdateTemplateRequest.Builder to create a
request.InternalServerException - We couldn't process your request because of an issue with the server. Try again later.ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same
Amazon Web Services Region as your request, and try your request again.ValidationException - The request isn't valid. Check the syntax and try again.ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - The requested operation would cause a conflict with the current state of a service resource associated
with the request. Resolve the conflict before retrying this request. See the accompanying error message
for details.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCasesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ConnectCasesClient create()
ConnectCasesClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ConnectCasesClientBuilder builder()
ConnectCasesClient.static ServiceMetadata serviceMetadata()
default ConnectCasesServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.