Interface ConnectCasesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCasesAsyncClient extends AwsClient
Service client for accessing ConnectCases asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • batchGetField

      default CompletableFuture<BatchGetFieldResponse> batchGetField(BatchGetFieldRequest batchGetFieldRequest)

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

      Parameters:
      batchGetFieldRequest -
      Returns:
      A Java Future containing the result of the BatchGetField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchGetField

      default CompletableFuture<BatchGetFieldResponse> batchGetField(Consumer<BatchGetFieldRequest.Builder> batchGetFieldRequest)

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


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

      Parameters:
      batchGetFieldRequest - A Consumer that will call methods on BatchGetFieldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchPutFieldOptions

      default CompletableFuture<BatchPutFieldOptionsResponse> batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)

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

      Parameters:
      batchPutFieldOptionsRequest -
      Returns:
      A Java Future containing the result of the BatchPutFieldOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchPutFieldOptions

      default CompletableFuture<BatchPutFieldOptionsResponse> batchPutFieldOptions(Consumer<BatchPutFieldOptionsRequest.Builder> batchPutFieldOptionsRequest)

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


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

      Parameters:
      batchPutFieldOptionsRequest - A Consumer that will call methods on BatchPutFieldOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchPutFieldOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCase

      default CompletableFuture<CreateCaseResponse> createCase(CreateCaseRequest createCaseRequest)

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

        <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>
      Parameters:
      createCaseRequest -
      Returns:
      A Java Future containing the result of the CreateCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCase

      default CompletableFuture<CreateCaseResponse> createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)

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

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

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

      Parameters:
      createCaseRequest - A Consumer that will call methods on CreateCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)

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

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

        </important>
      Parameters:
      createDomainRequest -
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)

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

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

        </important>

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

      Parameters:
      createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createField

      default CompletableFuture<CreateFieldResponse> createField(CreateFieldRequest createFieldRequest)

      Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

      Parameters:
      createFieldRequest -
      Returns:
      A Java Future containing the result of the CreateField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createField

      default CompletableFuture<CreateFieldResponse> createField(Consumer<CreateFieldRequest.Builder> createFieldRequest)

      Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.


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

      Parameters:
      createFieldRequest - A Consumer that will call methods on CreateFieldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLayout

      default CompletableFuture<CreateLayoutResponse> createLayout(CreateLayoutRequest createLayoutRequest)

      Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

      • Fields to display to the users

      • Field ordering

      Title and Status fields cannot be part of layouts since they are not configurable.

      Parameters:
      createLayoutRequest -
      Returns:
      A Java Future containing the result of the CreateLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLayout

      default CompletableFuture<CreateLayoutResponse> createLayout(Consumer<CreateLayoutRequest.Builder> createLayoutRequest)

      Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

      • Fields to display to the users

      • Field ordering

      Title and Status fields cannot be part of layouts since they are not configurable.


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

      Parameters:
      createLayoutRequest - A Consumer that will call methods on CreateLayoutRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRelatedItem

      default CompletableFuture<CreateRelatedItemResponse> createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest)

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

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

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

        </note>
      Parameters:
      createRelatedItemRequest -
      Returns:
      A Java Future containing the result of the CreateRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRelatedItem

      default CompletableFuture<CreateRelatedItemResponse> createRelatedItem(Consumer<CreateRelatedItemRequest.Builder> createRelatedItemRequest)

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

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

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

        </note>

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

      Parameters:
      createRelatedItemRequest - A Consumer that will call methods on CreateRelatedItemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createTemplate

      default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest)

      Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

      Parameters:
      createTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createTemplate

      default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)

      Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.


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

      Parameters:
      createTemplateRequest - A Consumer that will call methods on CreateTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Deletes a Cases domain. 

        <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
      Parameters:
      deleteDomainRequest -
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)

      Deletes a Cases domain. 

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

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

      Parameters:
      deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteField

      default CompletableFuture<DeleteFieldResponse> deleteField(DeleteFieldRequest deleteFieldRequest)

      Deletes a field from a cases template. You can delete up to 100 fields per domain.

      After a field is deleted:

      • You can still retrieve the field by calling BatchGetField.

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

      • Deleted fields are not included in the ListFields response.

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

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

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

      • GetTemplate does not return field IDs for deleted fields.

      • GetLayout does not return field IDs for deleted fields.

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

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

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

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

      Parameters:
      deleteFieldRequest -
      Returns:
      A Java Future containing the result of the DeleteField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteField

      default CompletableFuture<DeleteFieldResponse> deleteField(Consumer<DeleteFieldRequest.Builder> deleteFieldRequest)

      Deletes a field from a cases template. You can delete up to 100 fields per domain.

      After a field is deleted:

      • You can still retrieve the field by calling BatchGetField.

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

      • Deleted fields are not included in the ListFields response.

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

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

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

      • GetTemplate does not return field IDs for deleted fields.

      • GetLayout does not return field IDs for deleted fields.

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

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

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

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


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

      Parameters:
      deleteFieldRequest - A Consumer that will call methods on DeleteFieldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLayout

      default CompletableFuture<DeleteLayoutResponse> deleteLayout(DeleteLayoutRequest deleteLayoutRequest)

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

        <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
      Parameters:
      deleteLayoutRequest -
      Returns:
      A Java Future containing the result of the DeleteLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLayout

      default CompletableFuture<DeleteLayoutResponse> deleteLayout(Consumer<DeleteLayoutRequest.Builder> deleteLayoutRequest)

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

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

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

      Parameters:
      deleteLayoutRequest - A Consumer that will call methods on DeleteLayoutRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteTemplate

      default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)

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

        <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>
      Parameters:
      deleteTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteTemplate

      default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)

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

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

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

      Parameters:
      deleteTemplateRequest - A Consumer that will call methods on DeleteTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCase

      default CompletableFuture<GetCaseResponse> getCase(GetCaseRequest getCaseRequest)

      Returns information about a specific case if it exists.

      Parameters:
      getCaseRequest -
      Returns:
      A Java Future containing the result of the GetCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCase

      default CompletableFuture<GetCaseResponse> getCase(Consumer<GetCaseRequest.Builder> getCaseRequest)

      Returns information about a specific case if it exists.


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

      Parameters:
      getCaseRequest - A Consumer that will call methods on GetCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseAuditEvents

      default CompletableFuture<GetCaseAuditEventsResponse> getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest)

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

      Parameters:
      getCaseAuditEventsRequest -
      Returns:
      A Java Future containing the result of the GetCaseAuditEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseAuditEvents

      default CompletableFuture<GetCaseAuditEventsResponse> getCaseAuditEvents(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)

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


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

      Parameters:
      getCaseAuditEventsRequest - A Consumer that will call methods on GetCaseAuditEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCaseAuditEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseAuditEventsPaginator

      default GetCaseAuditEventsPublisher getCaseAuditEventsPaginator(GetCaseAuditEventsRequest getCaseAuditEventsRequest)

      This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsPublisher publisher = client.getCaseAuditEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsPublisher publisher = client.getCaseAuditEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseAuditEventsPaginator

      default GetCaseAuditEventsPublisher getCaseAuditEventsPaginator(Consumer<GetCaseAuditEventsRequest.Builder> getCaseAuditEventsRequest)

      This is a variant of getCaseAuditEvents(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsPublisher publisher = client.getCaseAuditEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCaseAuditEventsPublisher publisher = client.getCaseAuditEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.GetCaseAuditEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      getCaseAuditEventsRequest - A Consumer that will call methods on GetCaseAuditEventsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseEventConfiguration

      default CompletableFuture<GetCaseEventConfigurationResponse> getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)

      Returns the case event publishing configuration.

      Parameters:
      getCaseEventConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetCaseEventConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCaseEventConfiguration

      default CompletableFuture<GetCaseEventConfigurationResponse> getCaseEventConfiguration(Consumer<GetCaseEventConfigurationRequest.Builder> getCaseEventConfigurationRequest)

      Returns the case event publishing configuration.


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

      Parameters:
      getCaseEventConfigurationRequest - A Consumer that will call methods on GetCaseEventConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCaseEventConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCasePaginator

      default GetCasePublisher getCasePaginator(GetCaseRequest getCaseRequest)

      This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCasePublisher publisher = client.getCasePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCasePublisher publisher = client.getCasePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.GetCaseResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.GetCaseResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCasePaginator

      default GetCasePublisher getCasePaginator(Consumer<GetCaseRequest.Builder> getCaseRequest)

      This is a variant of getCase(software.amazon.awssdk.services.connectcases.model.GetCaseRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCasePublisher publisher = client.getCasePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.GetCasePublisher publisher = client.getCasePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.GetCaseResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.GetCaseResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      getCaseRequest - A Consumer that will call methods on GetCaseRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest)

      Returns information about a specific domain if it exists.

      Parameters:
      getDomainRequest -
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)

      Returns information about a specific domain if it exists.


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

      Parameters:
      getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLayout

      default CompletableFuture<GetLayoutResponse> getLayout(GetLayoutRequest getLayoutRequest)

      Returns the details for the requested layout.

      Parameters:
      getLayoutRequest -
      Returns:
      A Java Future containing the result of the GetLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLayout

      default CompletableFuture<GetLayoutResponse> getLayout(Consumer<GetLayoutRequest.Builder> getLayoutRequest)

      Returns the details for the requested layout.


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

      Parameters:
      getLayoutRequest - A Consumer that will call methods on GetLayoutRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getTemplate

      default CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest getTemplateRequest)

      Returns the details for the requested template.

      Parameters:
      getTemplateRequest -
      Returns:
      A Java Future containing the result of the GetTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getTemplate

      default CompletableFuture<GetTemplateResponse> getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)

      Returns the details for the requested template.


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

      Parameters:
      getTemplateRequest - A Consumer that will call methods on GetTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCasesForContact

      default CompletableFuture<ListCasesForContactResponse> listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)

      Lists cases for a given contact.

      Parameters:
      listCasesForContactRequest -
      Returns:
      A Java Future containing the result of the ListCasesForContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCasesForContact

      default CompletableFuture<ListCasesForContactResponse> listCasesForContact(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)

      Lists cases for a given contact.


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

      Parameters:
      listCasesForContactRequest - A Consumer that will call methods on ListCasesForContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCasesForContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCasesForContactPaginator

      default ListCasesForContactPublisher listCasesForContactPaginator(ListCasesForContactRequest listCasesForContactRequest)

      This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactPublisher publisher = client.listCasesForContactPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactPublisher publisher = client.listCasesForContactPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCasesForContactPaginator

      default ListCasesForContactPublisher listCasesForContactPaginator(Consumer<ListCasesForContactRequest.Builder> listCasesForContactRequest)

      This is a variant of listCasesForContact(software.amazon.awssdk.services.connectcases.model.ListCasesForContactRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactPublisher publisher = client.listCasesForContactPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListCasesForContactPublisher publisher = client.listCasesForContactPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListCasesForContactResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listCasesForContactRequest - A Consumer that will call methods on ListCasesForContactRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)

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

      Parameters:
      listDomainsRequest -
      Returns:
      A Java Future containing the result of the ListDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

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


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListDomainsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.connectcases.model.ListDomainsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListDomainsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldOptions

      default CompletableFuture<ListFieldOptionsResponse> listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)

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

      Parameters:
      listFieldOptionsRequest -
      Returns:
      A Java Future containing the result of the ListFieldOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldOptions

      default CompletableFuture<ListFieldOptionsResponse> listFieldOptions(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)

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


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

      Parameters:
      listFieldOptionsRequest - A Consumer that will call methods on ListFieldOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFieldOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldOptionsPaginator

      default ListFieldOptionsPublisher listFieldOptionsPaginator(ListFieldOptionsRequest listFieldOptionsRequest)

      This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsPublisher publisher = client.listFieldOptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsPublisher publisher = client.listFieldOptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldOptionsPaginator

      default ListFieldOptionsPublisher listFieldOptionsPaginator(Consumer<ListFieldOptionsRequest.Builder> listFieldOptionsRequest)

      This is a variant of listFieldOptions(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsPublisher publisher = client.listFieldOptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldOptionsPublisher publisher = client.listFieldOptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListFieldOptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listFieldOptionsRequest - A Consumer that will call methods on ListFieldOptionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFields

      default CompletableFuture<ListFieldsResponse> listFields(ListFieldsRequest listFieldsRequest)

      Lists all fields in a Cases domain.

      Parameters:
      listFieldsRequest -
      Returns:
      A Java Future containing the result of the ListFields operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFields

      default CompletableFuture<ListFieldsResponse> listFields(Consumer<ListFieldsRequest.Builder> listFieldsRequest)

      Lists all fields in a Cases domain.


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

      Parameters:
      listFieldsRequest - A Consumer that will call methods on ListFieldsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFields operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldsPaginator

      default ListFieldsPublisher listFieldsPaginator(ListFieldsRequest listFieldsRequest)

      This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsPublisher publisher = client.listFieldsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsPublisher publisher = client.listFieldsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListFieldsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListFieldsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFieldsPaginator

      default ListFieldsPublisher listFieldsPaginator(Consumer<ListFieldsRequest.Builder> listFieldsRequest)

      This is a variant of listFields(software.amazon.awssdk.services.connectcases.model.ListFieldsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsPublisher publisher = client.listFieldsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListFieldsPublisher publisher = client.listFieldsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListFieldsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListFieldsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listFieldsRequest - A Consumer that will call methods on ListFieldsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLayouts

      default CompletableFuture<ListLayoutsResponse> listLayouts(ListLayoutsRequest listLayoutsRequest)

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

      Parameters:
      listLayoutsRequest -
      Returns:
      A Java Future containing the result of the ListLayouts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLayouts

      default CompletableFuture<ListLayoutsResponse> listLayouts(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)

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


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

      Parameters:
      listLayoutsRequest - A Consumer that will call methods on ListLayoutsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLayouts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLayoutsPaginator

      default ListLayoutsPublisher listLayoutsPaginator(ListLayoutsRequest listLayoutsRequest)

      This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsPublisher publisher = client.listLayoutsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsPublisher publisher = client.listLayoutsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLayoutsPaginator

      default ListLayoutsPublisher listLayoutsPaginator(Consumer<ListLayoutsRequest.Builder> listLayoutsRequest)

      This is a variant of listLayouts(software.amazon.awssdk.services.connectcases.model.ListLayoutsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsPublisher publisher = client.listLayoutsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListLayoutsPublisher publisher = client.listLayoutsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListLayoutsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listLayoutsRequest - A Consumer that will call methods on ListLayoutsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists tags for a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists tags for a resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTemplates

      default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest)

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

      Parameters:
      listTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTemplates

      default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)

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


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

      Parameters:
      listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTemplatesPaginator

      default ListTemplatesPublisher listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)

      This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTemplatesPaginator

      default ListTemplatesPublisher listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)

      This is a variant of listTemplates(software.amazon.awssdk.services.connectcases.model.ListTemplatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.ListTemplatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putCaseEventConfiguration

      default CompletableFuture<PutCaseEventConfigurationResponse> putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)

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

      Parameters:
      putCaseEventConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutCaseEventConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putCaseEventConfiguration

      default CompletableFuture<PutCaseEventConfigurationResponse> putCaseEventConfiguration(Consumer<PutCaseEventConfigurationRequest.Builder> putCaseEventConfigurationRequest)

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


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

      Parameters:
      putCaseEventConfigurationRequest - A Consumer that will call methods on PutCaseEventConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutCaseEventConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchCases

      default CompletableFuture<SearchCasesResponse> searchCases(SearchCasesRequest searchCasesRequest)

      Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

      For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID .

      Parameters:
      searchCasesRequest -
      Returns:
      A Java Future containing the result of the SearchCases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchCases

      default CompletableFuture<SearchCasesResponse> searchCases(Consumer<SearchCasesRequest.Builder> searchCasesRequest)

      Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

      For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID .


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

      Parameters:
      searchCasesRequest - A Consumer that will call methods on SearchCasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchCases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchCasesPaginator

      default SearchCasesPublisher searchCasesPaginator(SearchCasesRequest searchCasesRequest)

      This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesPublisher publisher = client.searchCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesPublisher publisher = client.searchCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.SearchCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.SearchCasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchCasesPaginator

      default SearchCasesPublisher searchCasesPaginator(Consumer<SearchCasesRequest.Builder> searchCasesRequest)

      This is a variant of searchCases(software.amazon.awssdk.services.connectcases.model.SearchCasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesPublisher publisher = client.searchCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchCasesPublisher publisher = client.searchCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.SearchCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.SearchCasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      searchCasesRequest - A Consumer that will call methods on SearchCasesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRelatedItems

      default CompletableFuture<SearchRelatedItemsResponse> searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest)

      Searches for related items that are associated with a case.

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

      Parameters:
      searchRelatedItemsRequest -
      Returns:
      A Java Future containing the result of the SearchRelatedItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRelatedItems

      default CompletableFuture<SearchRelatedItemsResponse> searchRelatedItems(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)

      Searches for related items that are associated with a case.

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


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

      Parameters:
      searchRelatedItemsRequest - A Consumer that will call methods on SearchRelatedItemsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchRelatedItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRelatedItemsPaginator

      default SearchRelatedItemsPublisher searchRelatedItemsPaginator(SearchRelatedItemsRequest searchRelatedItemsRequest)

      This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsPublisher publisher = client.searchRelatedItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsPublisher publisher = client.searchRelatedItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRelatedItemsPaginator

      default SearchRelatedItemsPublisher searchRelatedItemsPaginator(Consumer<SearchRelatedItemsRequest.Builder> searchRelatedItemsRequest)

      This is a variant of searchRelatedItems(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsPublisher publisher = client.searchRelatedItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcases.paginators.SearchRelatedItemsPublisher publisher = client.searchRelatedItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcases.model.SearchRelatedItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      searchRelatedItemsRequest - A Consumer that will call methods on SearchRelatedItemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds tags to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds tags to a resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Untags a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Untags a resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCase

      default CompletableFuture<UpdateCaseResponse> updateCase(UpdateCaseRequest updateCaseRequest)

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

        <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
      Parameters:
      updateCaseRequest -
      Returns:
      A Java Future containing the result of the UpdateCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCase

      default CompletableFuture<UpdateCaseResponse> updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest)

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

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

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

      Parameters:
      updateCaseRequest - A Consumer that will call methods on UpdateCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateField

      default CompletableFuture<UpdateFieldResponse> updateField(UpdateFieldRequest updateFieldRequest)

      Updates the properties of an existing field.

      Parameters:
      updateFieldRequest -
      Returns:
      A Java Future containing the result of the UpdateField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateField

      default CompletableFuture<UpdateFieldResponse> updateField(Consumer<UpdateFieldRequest.Builder> updateFieldRequest)

      Updates the properties of an existing field.


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

      Parameters:
      updateFieldRequest - A Consumer that will call methods on UpdateFieldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateField operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateLayout

      default CompletableFuture<UpdateLayoutResponse> updateLayout(UpdateLayoutRequest updateLayoutRequest)

      Updates the attributes of an existing layout.

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

      A ValidationException is returned when you add non-existent fieldIds to a layout.

      Title and Status fields cannot be part of layouts because they are not configurable.

      Parameters:
      updateLayoutRequest -
      Returns:
      A Java Future containing the result of the UpdateLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateLayout

      default CompletableFuture<UpdateLayoutResponse> updateLayout(Consumer<UpdateLayoutRequest.Builder> updateLayoutRequest)

      Updates the attributes of an existing layout.

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

      A ValidationException is returned when you add non-existent fieldIds to a layout.

      Title and Status fields cannot be part of layouts because they are not configurable.


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

      Parameters:
      updateLayoutRequest - A Consumer that will call methods on UpdateLayoutRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLayout operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateTemplate

      default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest)

      Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

      Parameters:
      updateTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateTemplate

      default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)

      Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.


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

      Parameters:
      updateTemplateRequest - A Consumer that will call methods on UpdateTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default ConnectCasesServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ConnectCasesAsyncClient create()
      Create a ConnectCasesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ConnectCasesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ConnectCasesAsyncClient.