Interface ConnectCasesClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCasesClient extends AwsClient
Service client for accessing ConnectCases. This can be created using the staticbuilder()method.With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchGetField
default BatchGetFieldResponse batchGetField(BatchGetFieldRequest batchGetFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the description for the list of fields in the request parameters.
- Parameters:
batchGetFieldRequest-- Returns:
- Result of the BatchGetField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetField
default BatchGetFieldResponse batchGetField(Consumer<BatchGetFieldRequest.Builder> batchGetFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the description for the list of fields in the request parameters.
This is a convenience which creates an instance of the
BatchGetFieldRequest.Builderavoiding the need to create one manually viaBatchGetFieldRequest.builder()- Parameters:
batchGetFieldRequest- AConsumerthat will call methods onBatchGetFieldRequest.Builderto create a request.- Returns:
- Result of the BatchGetField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutFieldOptions
default BatchPutFieldOptionsResponse batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates and updates a set of field options for a single select field in a Cases domain.
- Parameters:
batchPutFieldOptionsRequest-- Returns:
- Result of the BatchPutFieldOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutFieldOptions
default BatchPutFieldOptionsResponse batchPutFieldOptions(Consumer<BatchPutFieldOptionsRequest.Builder> batchPutFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates and updates a set of field options for a single select field in a Cases domain.
This is a convenience which creates an instance of the
BatchPutFieldOptionsRequest.Builderavoiding the need to create one manually viaBatchPutFieldOptionsRequest.builder()- Parameters:
batchPutFieldOptionsRequest- AConsumerthat will call methods onBatchPutFieldOptionsRequest.Builderto create a request.- Returns:
- Result of the BatchPutFieldOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createCase
default CreateCaseResponse createCase(CreateCaseRequest createCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
If you provide a value for
PerformedBy.UserArnyou must also have connect:DescribeUser permission on the User ARN resource that you provide<p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>- Parameters:
createCaseRequest-- Returns:
- Result of the CreateCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createCase
default CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
If you provide a value for
PerformedBy.UserArnyou must also have connect:DescribeUser permission on the User ARN resource that you provide<p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>
This is a convenience which creates an instance of the
CreateCaseRequest.Builderavoiding the need to create one manually viaCreateCaseRequest.builder()- Parameters:
createCaseRequest- AConsumerthat will call methods onCreateCaseRequest.Builderto create a request.- Returns:
- Result of the CreateCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
</important>- Parameters:
createDomainRequest-- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
</important>
This is a convenience which creates an instance of the
CreateDomainRequest.Builderavoiding the need to create one manually viaCreateDomainRequest.builder()- Parameters:
createDomainRequest- AConsumerthat will call methods onCreateDomainRequest.Builderto create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createField
default CreateFieldResponse createField(CreateFieldRequest createFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
- Parameters:
createFieldRequest-- Returns:
- Result of the CreateField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createField
default CreateFieldResponse createField(Consumer<CreateFieldRequest.Builder> createFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
This is a convenience which creates an instance of the
CreateFieldRequest.Builderavoiding the need to create one manually viaCreateFieldRequest.builder()- Parameters:
createFieldRequest- AConsumerthat will call methods onCreateFieldRequest.Builderto create a request.- Returns:
- Result of the CreateField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createLayout
default CreateLayoutResponse createLayout(CreateLayoutRequest createLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
-
Fields to display to the users
-
Field ordering
Title and Status fields cannot be part of layouts since they are not configurable.
- Parameters:
createLayoutRequest-- Returns:
- Result of the CreateLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createLayout
default CreateLayoutResponse createLayout(Consumer<CreateLayoutRequest.Builder> createLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
-
Fields to display to the users
-
Field ordering
Title and Status fields cannot be part of layouts since they are not configurable.
This is a convenience which creates an instance of the
CreateLayoutRequest.Builderavoiding the need to create one manually viaCreateLayoutRequest.builder()- Parameters:
createLayoutRequest- AConsumerthat will call methods onCreateLayoutRequest.Builderto create a request.- Returns:
- Result of the CreateLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createRelatedItem
default CreateRelatedItemResponse createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a related item (comments, tasks, and contacts) and associates it with a case.
-
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a
contactArn). All Related Items have their own internal identifier, therelatedItemArn. Examples of related items includecommentsandcontacts. -
If you provide a value for
performedBy.userArnyou must also have DescribeUser permission on the ARN of the user that you provide.
</note>- Parameters:
createRelatedItemRequest-- Returns:
- Result of the CreateRelatedItem operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createRelatedItem
default CreateRelatedItemResponse createRelatedItem(Consumer<CreateRelatedItemRequest.Builder> createRelatedItemRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a related item (comments, tasks, and contacts) and associates it with a case.
-
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a
contactArn). All Related Items have their own internal identifier, therelatedItemArn. Examples of related items includecommentsandcontacts. -
If you provide a value for
performedBy.userArnyou must also have DescribeUser permission on the ARN of the user that you provide.
</note>
This is a convenience which creates an instance of the
CreateRelatedItemRequest.Builderavoiding the need to create one manually viaCreateRelatedItemRequest.builder()- Parameters:
createRelatedItemRequest- AConsumerthat will call methods onCreateRelatedItemRequest.Builderto create a request.- Returns:
- Result of the CreateRelatedItem operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createTemplate
default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
- Parameters:
createTemplateRequest-- Returns:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplate
default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
This is a convenience which creates an instance of the
CreateTemplateRequest.Builderavoiding the need to create one manually viaCreateTemplateRequest.builder()- Parameters:
createTemplateRequest- AConsumerthat will call methods onCreateTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a Cases domain.
<note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>- Parameters:
deleteDomainRequest-- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a Cases domain.
<note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
This is a convenience which creates an instance of the
DeleteDomainRequest.Builderavoiding the need to create one manually viaDeleteDomainRequest.builder()- Parameters:
deleteDomainRequest- AConsumerthat will call methods onDeleteDomainRequest.Builderto create a request.- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteField
default DeleteFieldResponse deleteField(DeleteFieldRequest deleteFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a field from a cases template. You can delete up to 100 fields per domain.
After a field is deleted:
-
You can still retrieve the field by calling
BatchGetField. -
You cannot update a deleted field by calling
UpdateField; it throws aValidationException. -
Deleted fields are not included in the
ListFieldsresponse. -
Calling
CreateCasewith a deleted field throws aValidationExceptiondenoting which field IDs in the request have been deleted. -
Calling
GetCasewith a deleted field ID returns the deleted field's value if one exists. -
Calling
UpdateCasewith a deleted field ID throws aValidationExceptionif the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (usingemptyValue: {}) the field's value from the case. -
GetTemplatedoes not return field IDs for deleted fields. -
GetLayoutdoes not return field IDs for deleted fields. -
Calling
SearchCaseswith the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. -
Calling
SearchCaseswith asearchTermvalue that matches a deleted field's value on a case returns the case in the response. -
Calling
BatchPutFieldOptionswith a deleted field ID throw aValidationException. -
Calling
GetCaseEventConfigurationdoes not return field IDs for deleted fields.
- Parameters:
deleteFieldRequest-- Returns:
- Result of the DeleteField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteField
default DeleteFieldResponse deleteField(Consumer<DeleteFieldRequest.Builder> deleteFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a field from a cases template. You can delete up to 100 fields per domain.
After a field is deleted:
-
You can still retrieve the field by calling
BatchGetField. -
You cannot update a deleted field by calling
UpdateField; it throws aValidationException. -
Deleted fields are not included in the
ListFieldsresponse. -
Calling
CreateCasewith a deleted field throws aValidationExceptiondenoting which field IDs in the request have been deleted. -
Calling
GetCasewith a deleted field ID returns the deleted field's value if one exists. -
Calling
UpdateCasewith a deleted field ID throws aValidationExceptionif the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (usingemptyValue: {}) the field's value from the case. -
GetTemplatedoes not return field IDs for deleted fields. -
GetLayoutdoes not return field IDs for deleted fields. -
Calling
SearchCaseswith the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. -
Calling
SearchCaseswith asearchTermvalue that matches a deleted field's value on a case returns the case in the response. -
Calling
BatchPutFieldOptionswith a deleted field ID throw aValidationException. -
Calling
GetCaseEventConfigurationdoes not return field IDs for deleted fields.
This is a convenience which creates an instance of the
DeleteFieldRequest.Builderavoiding the need to create one manually viaDeleteFieldRequest.builder()- Parameters:
deleteFieldRequest- AConsumerthat will call methods onDeleteFieldRequest.Builderto create a request.- Returns:
- Result of the DeleteField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteLayout
default DeleteLayoutResponse deleteLayout(DeleteLayoutRequest deleteLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>- Parameters:
deleteLayoutRequest-- Returns:
- Result of the DeleteLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLayout
default DeleteLayoutResponse deleteLayout(Consumer<DeleteLayoutRequest.Builder> deleteLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
This is a convenience which creates an instance of the
DeleteLayoutRequest.Builderavoiding the need to create one manually viaDeleteLayoutRequest.builder()- Parameters:
deleteLayoutRequest- AConsumerthat will call methods onDeleteLayoutRequest.Builderto create a request.- Returns:
- Result of the DeleteLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a cases template. You can delete up to 100 templates per domain.
<p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>- Parameters:
deleteTemplateRequest-- Returns:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Deletes a cases template. You can delete up to 100 templates per domain.
<p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>
This is a convenience which creates an instance of the
DeleteTemplateRequest.Builderavoiding the need to create one manually viaDeleteTemplateRequest.builder()- Parameters:
deleteTemplateRequest- AConsumerthat will call methods onDeleteTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCase
default GetCaseResponse getCase(GetCaseRequest getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific case if it exists.
- Parameters:
getCaseRequest-- Returns:
- Result of the GetCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCase
default GetCaseResponse getCase(Consumer<GetCaseRequest.Builder> getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific case if it exists.
This is a convenience which creates an instance of the
GetCaseRequest.Builderavoiding the need to create one manually viaGetCaseRequest.builder()- Parameters:
getCaseRequest- AConsumerthat will call methods onGetCaseRequest.Builderto create a request.- Returns:
- Result of the GetCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCasePaginator
default GetCaseIterable getCasePaginator(GetCaseRequest getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest)operation.- Parameters:
getCaseRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCasePaginator
default GetCaseIterable getCasePaginator(Consumer<GetCaseRequest.Builder> getCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.GetCaseIterable responses = client.getCasePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetCaseRequest.builder()- Parameters:
getCaseRequest- AConsumerthat will call methods onGetCaseRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseAuditEvents
default GetCaseAuditEventsResponse getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the audit history about a specific case if it exists.
- Parameters:
getCaseAuditEventsRequest-- Returns:
- Result of the GetCaseAuditEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseAuditEvents
default GetCaseAuditEventsResponse getCaseAuditEvents(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the audit history about a specific case if it exists.
This is a convenience which creates an instance of the
GetCaseAuditEventsRequest.Builderavoiding the need to create one manually viaGetCaseAuditEventsRequest.builder()- Parameters:
getCaseAuditEventsRequest- AConsumerthat will call methods onGetCaseAuditEventsRequest.Builderto create a request.- Returns:
- Result of the GetCaseAuditEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseAuditEventsPaginator
default GetCaseAuditEventsIterable getCaseAuditEventsPaginator(GetCaseAuditEventsRequest getCaseAuditEventsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client .getCaseAuditEventsPaginator(request); for (software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest)operation.- Parameters:
getCaseAuditEventsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseAuditEventsPaginator
default GetCaseAuditEventsIterable getCaseAuditEventsPaginator(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client .getCaseAuditEventsPaginator(request); for (software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsIterable responses = client.getCaseAuditEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest)operation.
This is a convenience which creates an instance of the
GetCaseAuditEventsRequest.Builderavoiding the need to create one manually viaGetCaseAuditEventsRequest.builder()- Parameters:
getCaseAuditEventsRequest- AConsumerthat will call methods onGetCaseAuditEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseEventConfiguration
default GetCaseEventConfigurationResponse getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the case event publishing configuration.
- Parameters:
getCaseEventConfigurationRequest-- Returns:
- Result of the GetCaseEventConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCaseEventConfiguration
default GetCaseEventConfigurationResponse getCaseEventConfiguration(Consumer<GetCaseEventConfigurationRequest.Builder> getCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the case event publishing configuration.
This is a convenience which creates an instance of the
GetCaseEventConfigurationRequest.Builderavoiding the need to create one manually viaGetCaseEventConfigurationRequest.builder()- Parameters:
getCaseEventConfigurationRequest- AConsumerthat will call methods onGetCaseEventConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetCaseEventConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomain
default GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific domain if it exists.
- Parameters:
getDomainRequest-- Returns:
- Result of the GetDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomain
default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns information about a specific domain if it exists.
This is a convenience which creates an instance of the
GetDomainRequest.Builderavoiding the need to create one manually viaGetDomainRequest.builder()- Parameters:
getDomainRequest- AConsumerthat will call methods onGetDomainRequest.Builderto create a request.- Returns:
- Result of the GetDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLayout
default GetLayoutResponse getLayout(GetLayoutRequest getLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested layout.
- Parameters:
getLayoutRequest-- Returns:
- Result of the GetLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLayout
default GetLayoutResponse getLayout(Consumer<GetLayoutRequest.Builder> getLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested layout.
This is a convenience which creates an instance of the
GetLayoutRequest.Builderavoiding the need to create one manually viaGetLayoutRequest.builder()- Parameters:
getLayoutRequest- AConsumerthat will call methods onGetLayoutRequest.Builderto create a request.- Returns:
- Result of the GetLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplate
default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested template.
- Parameters:
getTemplateRequest-- Returns:
- Result of the GetTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplate
default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Returns the details for the requested template.
This is a convenience which creates an instance of the
GetTemplateRequest.Builderavoiding the need to create one manually viaGetTemplateRequest.builder()- Parameters:
getTemplateRequest- AConsumerthat will call methods onGetTemplateRequest.Builderto create a request.- Returns:
- Result of the GetTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCasesForContact
default ListCasesForContactResponse listCasesForContact(ListCasesForContactRequest listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists cases for a given contact.
- Parameters:
listCasesForContactRequest-- Returns:
- Result of the ListCasesForContact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCasesForContact
default ListCasesForContactResponse listCasesForContact(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists cases for a given contact.
This is a convenience which creates an instance of the
ListCasesForContactRequest.Builderavoiding the need to create one manually viaListCasesForContactRequest.builder()- Parameters:
listCasesForContactRequest- AConsumerthat will call methods onListCasesForContactRequest.Builderto create a request.- Returns:
- Result of the ListCasesForContact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCasesForContactPaginator
default ListCasesForContactIterable listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest)operation.- Parameters:
listCasesForContactRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCasesForContactPaginator
default ListCasesForContactIterable listCasesForContactPaginator(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListCasesForContactIterable responses = client.listCasesForContactPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCasesForContactRequest.builder()- Parameters:
listCasesForContactRequest- AConsumerthat will call methods onListCasesForContactRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
- Parameters:
listDomainsRequest-- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest)operation.- Parameters:
listDomainsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldOptions
default ListFieldOptionsResponse listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all of the field options for a field identifier in the domain.
- Parameters:
listFieldOptionsRequest-- Returns:
- Result of the ListFieldOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldOptions
default ListFieldOptionsResponse listFieldOptions(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all of the field options for a field identifier in the domain.
This is a convenience which creates an instance of the
ListFieldOptionsRequest.Builderavoiding the need to create one manually viaListFieldOptionsRequest.builder()- Parameters:
listFieldOptionsRequest- AConsumerthat will call methods onListFieldOptionsRequest.Builderto create a request.- Returns:
- Result of the ListFieldOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldOptionsPaginator
default ListFieldOptionsIterable listFieldOptionsPaginator(ListFieldOptionsRequest listFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest)operation.- Parameters:
listFieldOptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldOptionsPaginator
default ListFieldOptionsIterable listFieldOptionsPaginator(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsIterable responses = client.listFieldOptionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListFieldOptionsRequest.builder()- Parameters:
listFieldOptionsRequest- AConsumerthat will call methods onListFieldOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFields
default ListFieldsResponse listFields(ListFieldsRequest listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all fields in a Cases domain.
- Parameters:
listFieldsRequest-- Returns:
- Result of the ListFields operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFields
default ListFieldsResponse listFields(Consumer<ListFieldsRequest.Builder> listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all fields in a Cases domain.
This is a convenience which creates an instance of the
ListFieldsRequest.Builderavoiding the need to create one manually viaListFieldsRequest.builder()- Parameters:
listFieldsRequest- AConsumerthat will call methods onListFieldsRequest.Builderto create a request.- Returns:
- Result of the ListFields operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldsPaginator
default ListFieldsIterable listFieldsPaginator(ListFieldsRequest listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest)operation.- Parameters:
listFieldsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFieldsPaginator
default ListFieldsIterable listFieldsPaginator(Consumer<ListFieldsRequest.Builder> listFieldsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListFieldsIterable responses = client.listFieldsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListFieldsRequest.builder()- Parameters:
listFieldsRequest- AConsumerthat will call methods onListFieldsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLayouts
default ListLayoutsResponse listLayouts(ListLayoutsRequest listLayoutsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
- Parameters:
listLayoutsRequest-- Returns:
- Result of the ListLayouts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLayouts
default ListLayoutsResponse listLayouts(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
This is a convenience which creates an instance of the
ListLayoutsRequest.Builderavoiding the need to create one manually viaListLayoutsRequest.builder()- Parameters:
listLayoutsRequest- AConsumerthat will call methods onListLayoutsRequest.Builderto create a request.- Returns:
- Result of the ListLayouts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLayoutsPaginator
default ListLayoutsIterable listLayoutsPaginator(ListLayoutsRequest listLayoutsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest)operation.- Parameters:
listLayoutsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLayoutsPaginator
default ListLayoutsIterable listLayoutsPaginator(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListLayoutsIterable responses = client.listLayoutsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLayoutsRequest.builder()- Parameters:
listLayoutsRequest- AConsumerthat will call methods onListLayoutsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists tags for a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
- Parameters:
listTemplatesRequest-- Returns:
- Result of the ListTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest)operation.- Parameters:
listTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putCaseEventConfiguration
default PutCaseEventConfigurationResponse putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
- Parameters:
putCaseEventConfigurationRequest-- Returns:
- Result of the PutCaseEventConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putCaseEventConfiguration
default PutCaseEventConfigurationResponse putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
This is a convenience which creates an instance of the
PutCaseEventConfigurationRequest.Builderavoiding the need to create one manually viaPutCaseEventConfigurationRequest.builder()- Parameters:
putCaseEventConfigurationRequest- AConsumerthat will call methods onPutCaseEventConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutCaseEventConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchCases
default SearchCasesResponse searchCases(SearchCasesRequest searchCasesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For
customer_idyou must provide the full customer profile ARN in this format:arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.- Parameters:
searchCasesRequest-- Returns:
- Result of the SearchCases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchCases
default SearchCasesResponse searchCases(Consumer<SearchCasesRequest.Builder> searchCasesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For
customer_idyou 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.Builderavoiding the need to create one manually viaSearchCasesRequest.builder()- Parameters:
searchCasesRequest- AConsumerthat will call methods onSearchCasesRequest.Builderto create a request.- Returns:
- Result of the SearchCases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchCasesPaginator
default SearchCasesIterable searchCasesPaginator(SearchCasesRequest searchCasesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest)operation.- Parameters:
searchCasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchCasesPaginator
default SearchCasesIterable searchCasesPaginator(Consumer<SearchCasesRequest.Builder> searchCasesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.SearchCasesIterable responses = client.searchCasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchCasesRequest.builder()- Parameters:
searchCasesRequest- AConsumerthat will call methods onSearchCasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchRelatedItems
default SearchRelatedItemsResponse searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
- Parameters:
searchRelatedItemsRequest-- Returns:
- Result of the SearchRelatedItems operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchRelatedItems
default SearchRelatedItemsResponse searchRelatedItems(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
This is a convenience which creates an instance of the
SearchRelatedItemsRequest.Builderavoiding the need to create one manually viaSearchRelatedItemsRequest.builder()- Parameters:
searchRelatedItemsRequest- AConsumerthat will call methods onSearchRelatedItemsRequest.Builderto create a request.- Returns:
- Result of the SearchRelatedItems operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchRelatedItemsPaginator
default SearchRelatedItemsIterable searchRelatedItemsPaginator(SearchRelatedItemsRequest searchRelatedItemsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest)operation.- Parameters:
searchRelatedItemsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchRelatedItemsPaginator
default SearchRelatedItemsIterable searchRelatedItemsPaginator(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
This is a variant of
searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsIterable responses = client.searchRelatedItemsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchRelatedItemsRequest.builder()- Parameters:
searchRelatedItemsRequest- AConsumerthat will call methods onSearchRelatedItemsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Adds tags to a resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Adds tags to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Untags a resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
Untags a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateCase
default UpdateCaseResponse updateCase(UpdateCaseRequest updateCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
If you provide a value for
PerformedBy.UserArnyou must also have connect:DescribeUser permission on the User ARN resource that you provide<p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>- Parameters:
updateCaseRequest-- Returns:
- Result of the UpdateCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateCase
default UpdateCaseResponse updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCasesException
If you provide a value for
PerformedBy.UserArnyou must also have connect:DescribeUser permission on the User ARN resource that you provide<p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
This is a convenience which creates an instance of the
UpdateCaseRequest.Builderavoiding the need to create one manually viaUpdateCaseRequest.builder()- Parameters:
updateCaseRequest- AConsumerthat will call methods onUpdateCaseRequest.Builderto create a request.- Returns:
- Result of the UpdateCase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateField
default UpdateFieldResponse updateField(UpdateFieldRequest updateFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the properties of an existing field.
- Parameters:
updateFieldRequest-- Returns:
- Result of the UpdateField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateField
default UpdateFieldResponse updateField(Consumer<UpdateFieldRequest.Builder> updateFieldRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the properties of an existing field.
This is a convenience which creates an instance of the
UpdateFieldRequest.Builderavoiding the need to create one manually viaUpdateFieldRequest.builder()- Parameters:
updateFieldRequest- AConsumerthat will call methods onUpdateFieldRequest.Builderto create a request.- Returns:
- Result of the UpdateField operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLayout
default UpdateLayoutResponse updateLayout(UpdateLayoutRequest updateLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A
ValidationExceptionis returned when you add non-existentfieldIdsto a layout.Title and Status fields cannot be part of layouts because they are not configurable.
- Parameters:
updateLayoutRequest-- Returns:
- Result of the UpdateLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLayout
default UpdateLayoutResponse updateLayout(Consumer<UpdateLayoutRequest.Builder> updateLayoutRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A
ValidationExceptionis returned when you add non-existentfieldIdsto 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.Builderavoiding the need to create one manually viaUpdateLayoutRequest.builder()- Parameters:
updateLayoutRequest- AConsumerthat will call methods onUpdateLayoutRequest.Builderto create a request.- Returns:
- Result of the UpdateLayout operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the attributes of an existing template. The template attributes that can be modified include
name,description,layoutConfiguration,requiredFields, andstatus. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.- Parameters:
updateTemplateRequest-- Returns:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, ConnectCasesException
Updates the attributes of an existing template. The template attributes that can be modified include
name,description,layoutConfiguration,requiredFields, andstatus. 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.Builderavoiding the need to create one manually viaUpdateTemplateRequest.builder()- Parameters:
updateTemplateRequest- AConsumerthat will call methods onUpdateTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ConnectCasesClient create()
Create aConnectCasesClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ConnectCasesClientBuilder builder()
Create a builder that can be used to configure and create aConnectCasesClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ConnectCasesServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-