Interface ComprehendAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ComprehendAsyncClient extends AwsClient
Service client for accessing Amazon Comprehend 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.

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

  • Field Details

  • Method Details

    • batchDetectDominantLanguage

      default CompletableFuture<BatchDetectDominantLanguageResponse> batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)

      Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

      Parameters:
      batchDetectDominantLanguageRequest -
      Returns:
      A Java Future containing the result of the BatchDetectDominantLanguage 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectDominantLanguage

      default CompletableFuture<BatchDetectDominantLanguageResponse> batchDetectDominantLanguage(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest)

      Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.


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

      Parameters:
      batchDetectDominantLanguageRequest - A Consumer that will call methods on BatchDetectDominantLanguageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectDominantLanguage 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectEntities

      default CompletableFuture<BatchDetectEntitiesResponse> batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest)

      Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

      Parameters:
      batchDetectEntitiesRequest -
      Returns:
      A Java Future containing the result of the BatchDetectEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectEntities

      default CompletableFuture<BatchDetectEntitiesResponse> batchDetectEntities(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest)

      Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.


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

      Parameters:
      batchDetectEntitiesRequest - A Consumer that will call methods on BatchDetectEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectKeyPhrases

      default CompletableFuture<BatchDetectKeyPhrasesResponse> batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)

      Detects the key noun phrases found in a batch of documents.

      Parameters:
      batchDetectKeyPhrasesRequest -
      Returns:
      A Java Future containing the result of the BatchDetectKeyPhrases 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectKeyPhrases

      default CompletableFuture<BatchDetectKeyPhrasesResponse> batchDetectKeyPhrases(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest)

      Detects the key noun phrases found in a batch of documents.


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

      Parameters:
      batchDetectKeyPhrasesRequest - A Consumer that will call methods on BatchDetectKeyPhrasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectKeyPhrases 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectSentiment

      default CompletableFuture<BatchDetectSentimentResponse> batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest)

      Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

      Parameters:
      batchDetectSentimentRequest -
      Returns:
      A Java Future containing the result of the BatchDetectSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectSentiment

      default CompletableFuture<BatchDetectSentimentResponse> batchDetectSentiment(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest)

      Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.


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

      Parameters:
      batchDetectSentimentRequest - A Consumer that will call methods on BatchDetectSentimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectSyntax

      default CompletableFuture<BatchDetectSyntaxResponse> batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest)

      Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.

      Parameters:
      batchDetectSyntaxRequest -
      Returns:
      A Java Future containing the result of the BatchDetectSyntax 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectSyntax

      default CompletableFuture<BatchDetectSyntaxResponse> batchDetectSyntax(Consumer<BatchDetectSyntaxRequest.Builder> batchDetectSyntaxRequest)

      Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.


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

      Parameters:
      batchDetectSyntaxRequest - A Consumer that will call methods on BatchDetectSyntaxRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectSyntax 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectTargetedSentiment

      default CompletableFuture<BatchDetectTargetedSentimentResponse> batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest)

      Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

      For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

      Parameters:
      batchDetectTargetedSentimentRequest -
      Returns:
      A Java Future containing the result of the BatchDetectTargetedSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDetectTargetedSentiment

      default CompletableFuture<BatchDetectTargetedSentimentResponse> batchDetectTargetedSentiment(Consumer<BatchDetectTargetedSentimentRequest.Builder> batchDetectTargetedSentimentRequest)

      Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

      For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.


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

      Parameters:
      batchDetectTargetedSentimentRequest - A Consumer that will call methods on BatchDetectTargetedSentimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDetectTargetedSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • classifyDocument

      default CompletableFuture<ClassifyDocumentResponse> classifyDocument(ClassifyDocumentRequest classifyDocumentRequest)

      Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

      • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

      • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

      If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

      If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

      Parameters:
      classifyDocumentRequest -
      Returns:
      A Java Future containing the result of the ClassifyDocument 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.
      • InvalidRequestException The request is invalid.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • classifyDocument

      default CompletableFuture<ClassifyDocumentResponse> classifyDocument(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest)

      Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

      • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

      • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

      If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

      If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.


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

      Parameters:
      classifyDocumentRequest - A Consumer that will call methods on ClassifyDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ClassifyDocument 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.
      • InvalidRequestException The request is invalid.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • containsPiiEntities

      default CompletableFuture<ContainsPiiEntitiesResponse> containsPiiEntities(ContainsPiiEntitiesRequest containsPiiEntitiesRequest)

      Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

      Parameters:
      containsPiiEntitiesRequest -
      Returns:
      A Java Future containing the result of the ContainsPiiEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • containsPiiEntities

      default CompletableFuture<ContainsPiiEntitiesResponse> containsPiiEntities(Consumer<ContainsPiiEntitiesRequest.Builder> containsPiiEntitiesRequest)

      Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.


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

      Parameters:
      containsPiiEntitiesRequest - A Consumer that will call methods on ContainsPiiEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ContainsPiiEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)

      Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      createDatasetRequest -
      Returns:
      A Java Future containing the result of the CreateDataset 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)

      Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataset 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDocumentClassifier

      default CompletableFuture<CreateDocumentClassifierResponse> createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest)

      Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.

      Parameters:
      createDocumentClassifierRequest -
      Returns:
      A Java Future containing the result of the CreateDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDocumentClassifier

      default CompletableFuture<CreateDocumentClassifierResponse> createDocumentClassifier(Consumer<CreateDocumentClassifierRequest.Builder> createDocumentClassifierRequest)

      Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.


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

      Parameters:
      createDocumentClassifierRequest - A Consumer that will call methods on CreateDocumentClassifierRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(CreateEndpointRequest createEndpointRequest)

      Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

      Parameters:
      createEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateEndpoint 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)

      Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.


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

      Parameters:
      createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEndpoint 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEntityRecognizer

      default CompletableFuture<CreateEntityRecognizerResponse> createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest)

      Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

      Parameters:
      createEntityRecognizerRequest -
      Returns:
      A Java Future containing the result of the CreateEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEntityRecognizer

      default CompletableFuture<CreateEntityRecognizerResponse> createEntityRecognizer(Consumer<CreateEntityRecognizerRequest.Builder> createEntityRecognizerRequest)

      Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.


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

      Parameters:
      createEntityRecognizerRequest - A Consumer that will call methods on CreateEntityRecognizerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlywheel

      default CompletableFuture<CreateFlywheelResponse> createFlywheel(CreateFlywheelRequest createFlywheelRequest)

      A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

      When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

      To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

      To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

      For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      createFlywheelRequest -
      Returns:
      A Java Future containing the result of the CreateFlywheel 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlywheel

      default CompletableFuture<CreateFlywheelResponse> createFlywheel(Consumer<CreateFlywheelRequest.Builder> createFlywheelRequest)

      A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

      When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

      To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

      To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

      For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      createFlywheelRequest - A Consumer that will call methods on CreateFlywheelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFlywheel 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDocumentClassifier

      default CompletableFuture<DeleteDocumentClassifierResponse> deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest)

      Deletes a previously created document classifier

      Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

      This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

      Parameters:
      deleteDocumentClassifierRequest -
      Returns:
      A Java Future containing the result of the DeleteDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDocumentClassifier

      default CompletableFuture<DeleteDocumentClassifierResponse> deleteDocumentClassifier(Consumer<DeleteDocumentClassifierRequest.Builder> deleteDocumentClassifierRequest)

      Deletes a previously created document classifier

      Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

      This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.


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

      Parameters:
      deleteDocumentClassifierRequest - A Consumer that will call methods on DeleteDocumentClassifierRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

      Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.

      Parameters:
      deleteEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)

      Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.


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

      Parameters:
      deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • InvalidRequestException The request is invalid.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEntityRecognizer

      default CompletableFuture<DeleteEntityRecognizerResponse> deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)

      Deletes an entity recognizer.

      Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

      This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

      Parameters:
      deleteEntityRecognizerRequest -
      Returns:
      A Java Future containing the result of the DeleteEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEntityRecognizer

      default CompletableFuture<DeleteEntityRecognizerResponse> deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest)

      Deletes an entity recognizer.

      Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

      This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.


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

      Parameters:
      deleteEntityRecognizerRequest - A Consumer that will call methods on DeleteEntityRecognizerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlywheel

      default CompletableFuture<DeleteFlywheelResponse> deleteFlywheel(DeleteFlywheelRequest deleteFlywheelRequest)

      Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

      For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      deleteFlywheelRequest -
      Returns:
      A Java Future containing the result of the DeleteFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlywheel

      default CompletableFuture<DeleteFlywheelResponse> deleteFlywheel(Consumer<DeleteFlywheelRequest.Builder> deleteFlywheelRequest)

      Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

      For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      deleteFlywheelRequest - A Consumer that will call methods on DeleteFlywheelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

      Deletes a resource-based policy that is attached to a custom model.

      Parameters:
      deleteResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

      Deletes a resource-based policy that is attached to a custom model.


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

      Parameters:
      deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest)

      Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      describeDatasetRequest -
      Returns:
      A Java Future containing the result of the DescribeDataset 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)

      Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataset 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentClassificationJob

      default CompletableFuture<DescribeDocumentClassificationJobResponse> describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest)

      Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

      Parameters:
      describeDocumentClassificationJobRequest -
      Returns:
      A Java Future containing the result of the DescribeDocumentClassificationJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentClassificationJob

      default CompletableFuture<DescribeDocumentClassificationJobResponse> describeDocumentClassificationJob(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest)

      Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.


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

      Parameters:
      describeDocumentClassificationJobRequest - A Consumer that will call methods on DescribeDocumentClassificationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDocumentClassificationJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentClassifier

      default CompletableFuture<DescribeDocumentClassifierResponse> describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest)

      Gets the properties associated with a document classifier.

      Parameters:
      describeDocumentClassifierRequest -
      Returns:
      A Java Future containing the result of the DescribeDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentClassifier

      default CompletableFuture<DescribeDocumentClassifierResponse> describeDocumentClassifier(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest)

      Gets the properties associated with a document classifier.


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

      Parameters:
      describeDocumentClassifierRequest - A Consumer that will call methods on DescribeDocumentClassifierRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDominantLanguageDetectionJob

      default CompletableFuture<DescribeDominantLanguageDetectionJobResponse> describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)

      Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

      Parameters:
      describeDominantLanguageDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDominantLanguageDetectionJob

      default CompletableFuture<DescribeDominantLanguageDetectionJobResponse> describeDominantLanguageDetectionJob(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest)

      Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.


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

      Parameters:
      describeDominantLanguageDetectionJobRequest - A Consumer that will call methods on DescribeDominantLanguageDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpoint

      default CompletableFuture<DescribeEndpointResponse> describeEndpoint(DescribeEndpointRequest describeEndpointRequest)

      Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

      Parameters:
      describeEndpointRequest -
      Returns:
      A Java Future containing the result of the DescribeEndpoint 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpoint

      default CompletableFuture<DescribeEndpointResponse> describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest)

      Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.


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

      Parameters:
      describeEndpointRequest - A Consumer that will call methods on DescribeEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEndpoint 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEntitiesDetectionJob

      default CompletableFuture<DescribeEntitiesDetectionJobResponse> describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)

      Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

      Parameters:
      describeEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEntitiesDetectionJob

      default CompletableFuture<DescribeEntitiesDetectionJobResponse> describeEntitiesDetectionJob(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest)

      Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.


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

      Parameters:
      describeEntitiesDetectionJobRequest - A Consumer that will call methods on DescribeEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEntityRecognizer

      default CompletableFuture<DescribeEntityRecognizerResponse> describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest)

      Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

      Parameters:
      describeEntityRecognizerRequest -
      Returns:
      A Java Future containing the result of the DescribeEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEntityRecognizer

      default CompletableFuture<DescribeEntityRecognizerResponse> describeEntityRecognizer(Consumer<DescribeEntityRecognizerRequest.Builder> describeEntityRecognizerRequest)

      Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.


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

      Parameters:
      describeEntityRecognizerRequest - A Consumer that will call methods on DescribeEntityRecognizerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventsDetectionJob

      default CompletableFuture<DescribeEventsDetectionJobResponse> describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest)

      Gets the status and details of an events detection job.

      Parameters:
      describeEventsDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventsDetectionJob

      default CompletableFuture<DescribeEventsDetectionJobResponse> describeEventsDetectionJob(Consumer<DescribeEventsDetectionJobRequest.Builder> describeEventsDetectionJobRequest)

      Gets the status and details of an events detection job.


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

      Parameters:
      describeEventsDetectionJobRequest - A Consumer that will call methods on DescribeEventsDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlywheel

      default CompletableFuture<DescribeFlywheelResponse> describeFlywheel(DescribeFlywheelRequest describeFlywheelRequest)

      Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      describeFlywheelRequest -
      Returns:
      A Java Future containing the result of the DescribeFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlywheel

      default CompletableFuture<DescribeFlywheelResponse> describeFlywheel(Consumer<DescribeFlywheelRequest.Builder> describeFlywheelRequest)

      Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      describeFlywheelRequest - A Consumer that will call methods on DescribeFlywheelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlywheelIteration

      default CompletableFuture<DescribeFlywheelIterationResponse> describeFlywheelIteration(DescribeFlywheelIterationRequest describeFlywheelIterationRequest)

      Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      describeFlywheelIterationRequest -
      Returns:
      A Java Future containing the result of the DescribeFlywheelIteration 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlywheelIteration

      default CompletableFuture<DescribeFlywheelIterationResponse> describeFlywheelIteration(Consumer<DescribeFlywheelIterationRequest.Builder> describeFlywheelIterationRequest)

      Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      describeFlywheelIterationRequest - A Consumer that will call methods on DescribeFlywheelIterationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFlywheelIteration 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeKeyPhrasesDetectionJob

      default CompletableFuture<DescribeKeyPhrasesDetectionJobResponse> describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)

      Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

      Parameters:
      describeKeyPhrasesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeKeyPhrasesDetectionJob

      default CompletableFuture<DescribeKeyPhrasesDetectionJobResponse> describeKeyPhrasesDetectionJob(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest)

      Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.


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

      Parameters:
      describeKeyPhrasesDetectionJobRequest - A Consumer that will call methods on DescribeKeyPhrasesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePiiEntitiesDetectionJob

      default CompletableFuture<DescribePiiEntitiesDetectionJobResponse> describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest)

      Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

      Parameters:
      describePiiEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribePiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePiiEntitiesDetectionJob

      default CompletableFuture<DescribePiiEntitiesDetectionJobResponse> describePiiEntitiesDetectionJob(Consumer<DescribePiiEntitiesDetectionJobRequest.Builder> describePiiEntitiesDetectionJobRequest)

      Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.


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

      Parameters:
      describePiiEntitiesDetectionJobRequest - A Consumer that will call methods on DescribePiiEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeResourcePolicy

      default CompletableFuture<DescribeResourcePolicyResponse> describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)

      Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

      Parameters:
      describeResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the DescribeResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeResourcePolicy

      default CompletableFuture<DescribeResourcePolicyResponse> describeResourcePolicy(Consumer<DescribeResourcePolicyRequest.Builder> describeResourcePolicyRequest)

      Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.


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

      Parameters:
      describeResourcePolicyRequest - A Consumer that will call methods on DescribeResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSentimentDetectionJob

      default CompletableFuture<DescribeSentimentDetectionJobResponse> describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)

      Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

      Parameters:
      describeSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSentimentDetectionJob

      default CompletableFuture<DescribeSentimentDetectionJobResponse> describeSentimentDetectionJob(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest)

      Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.


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

      Parameters:
      describeSentimentDetectionJobRequest - A Consumer that will call methods on DescribeSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTargetedSentimentDetectionJob

      default CompletableFuture<DescribeTargetedSentimentDetectionJobResponse> describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest)

      Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

      Parameters:
      describeTargetedSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTargetedSentimentDetectionJob

      default CompletableFuture<DescribeTargetedSentimentDetectionJobResponse> describeTargetedSentimentDetectionJob(Consumer<DescribeTargetedSentimentDetectionJobRequest.Builder> describeTargetedSentimentDetectionJobRequest)

      Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.


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

      Parameters:
      describeTargetedSentimentDetectionJobRequest - A Consumer that will call methods on DescribeTargetedSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTopicsDetectionJob

      default CompletableFuture<DescribeTopicsDetectionJobResponse> describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)

      Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

      Parameters:
      describeTopicsDetectionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeTopicsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTopicsDetectionJob

      default CompletableFuture<DescribeTopicsDetectionJobResponse> describeTopicsDetectionJob(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest)

      Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.


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

      Parameters:
      describeTopicsDetectionJobRequest - A Consumer that will call methods on DescribeTopicsDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTopicsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectDominantLanguage

      default CompletableFuture<DetectDominantLanguageResponse> detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest)

      Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

      Parameters:
      detectDominantLanguageRequest -
      Returns:
      A Java Future containing the result of the DetectDominantLanguage 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectDominantLanguage

      default CompletableFuture<DetectDominantLanguageResponse> detectDominantLanguage(Consumer<DetectDominantLanguageRequest.Builder> detectDominantLanguageRequest)

      Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.


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

      Parameters:
      detectDominantLanguageRequest - A Consumer that will call methods on DetectDominantLanguageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectDominantLanguage 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectEntities

      default CompletableFuture<DetectEntitiesResponse> detectEntities(DetectEntitiesRequest detectEntitiesRequest)

      Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

      When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

      When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

      If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

      If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

      Parameters:
      detectEntitiesRequest -
      Returns:
      A Java Future containing the result of the DetectEntities 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.
      • InvalidRequestException The request is invalid.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectEntities

      default CompletableFuture<DetectEntitiesResponse> detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)

      Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

      When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

      When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

      If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

      If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.


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

      Parameters:
      detectEntitiesRequest - A Consumer that will call methods on DetectEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectEntities 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.
      • InvalidRequestException The request is invalid.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectKeyPhrases

      default CompletableFuture<DetectKeyPhrasesResponse> detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest)

      Detects the key noun phrases found in the text.

      Parameters:
      detectKeyPhrasesRequest -
      Returns:
      A Java Future containing the result of the DetectKeyPhrases 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectKeyPhrases

      default CompletableFuture<DetectKeyPhrasesResponse> detectKeyPhrases(Consumer<DetectKeyPhrasesRequest.Builder> detectKeyPhrasesRequest)

      Detects the key noun phrases found in the text.


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

      Parameters:
      detectKeyPhrasesRequest - A Consumer that will call methods on DetectKeyPhrasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectKeyPhrases 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectPiiEntities

      default CompletableFuture<DetectPiiEntitiesResponse> detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest)

      Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

      Parameters:
      detectPiiEntitiesRequest -
      Returns:
      A Java Future containing the result of the DetectPiiEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectPiiEntities

      default CompletableFuture<DetectPiiEntitiesResponse> detectPiiEntities(Consumer<DetectPiiEntitiesRequest.Builder> detectPiiEntitiesRequest)

      Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.


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

      Parameters:
      detectPiiEntitiesRequest - A Consumer that will call methods on DetectPiiEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectPiiEntities 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectSentiment

      default CompletableFuture<DetectSentimentResponse> detectSentiment(DetectSentimentRequest detectSentimentRequest)

      Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

      Parameters:
      detectSentimentRequest -
      Returns:
      A Java Future containing the result of the DetectSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectSentiment

      default CompletableFuture<DetectSentimentResponse> detectSentiment(Consumer<DetectSentimentRequest.Builder> detectSentimentRequest)

      Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).


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

      Parameters:
      detectSentimentRequest - A Consumer that will call methods on DetectSentimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectSyntax

      default CompletableFuture<DetectSyntaxResponse> detectSyntax(DetectSyntaxRequest detectSyntaxRequest)

      Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.

      Parameters:
      detectSyntaxRequest -
      Returns:
      A Java Future containing the result of the DetectSyntax 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectSyntax

      default CompletableFuture<DetectSyntaxResponse> detectSyntax(Consumer<DetectSyntaxRequest.Builder> detectSyntaxRequest)

      Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.


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

      Parameters:
      detectSyntaxRequest - A Consumer that will call methods on DetectSyntaxRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectSyntax 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectTargetedSentiment

      default CompletableFuture<DetectTargetedSentimentResponse> detectTargetedSentiment(DetectTargetedSentimentRequest detectTargetedSentimentRequest)

      Inspects the input text and returns a sentiment analysis for each entity identified in the text.

      For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

      Parameters:
      detectTargetedSentimentRequest -
      Returns:
      A Java Future containing the result of the DetectTargetedSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectTargetedSentiment

      default CompletableFuture<DetectTargetedSentimentResponse> detectTargetedSentiment(Consumer<DetectTargetedSentimentRequest.Builder> detectTargetedSentimentRequest)

      Inspects the input text and returns a sentiment analysis for each entity identified in the text.

      For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.


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

      Parameters:
      detectTargetedSentimentRequest - A Consumer that will call methods on DetectTargetedSentimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectTargetedSentiment 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectToxicContent

      default CompletableFuture<DetectToxicContentResponse> detectToxicContent(DetectToxicContentRequest detectToxicContentRequest)

      Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

      Parameters:
      detectToxicContentRequest -
      Returns:
      A Java Future containing the result of the DetectToxicContent 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detectToxicContent

      default CompletableFuture<DetectToxicContentResponse> detectToxicContent(Consumer<DetectToxicContentRequest.Builder> detectToxicContentRequest)

      Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.


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

      Parameters:
      detectToxicContentRequest - A Consumer that will call methods on DetectToxicContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectToxicContent 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.
      • InvalidRequestException The request is invalid.
      • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
      • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importModel

      default CompletableFuture<ImportModelResponse> importModel(ImportModelRequest importModelRequest)

      Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

      If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

      The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

      Parameters:
      importModelRequest -
      Returns:
      A Java Future containing the result of the ImportModel 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importModel

      default CompletableFuture<ImportModelResponse> importModel(Consumer<ImportModelRequest.Builder> importModelRequest)

      Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

      If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

      The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.


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

      Parameters:
      importModelRequest - A Consumer that will call methods on ImportModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportModel 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)

      List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      listDatasetsRequest -
      Returns:
      A Java Future containing the result of the ListDatasets 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

      List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatasets 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) 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.comprehend.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse 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 listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) operation.

      Parameters:
      listDatasetsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) 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.comprehend.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse 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 listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) operation.


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobs

      default CompletableFuture<ListDocumentClassificationJobsResponse> listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)

      Gets a list of the documentation classification jobs that you have submitted.

      Parameters:
      listDocumentClassificationJobsRequest -
      Returns:
      A Java Future containing the result of the ListDocumentClassificationJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobs

      default CompletableFuture<ListDocumentClassificationJobsResponse> listDocumentClassificationJobs(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest)

      Gets a list of the documentation classification jobs that you have submitted.


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

      Parameters:
      listDocumentClassificationJobsRequest - A Consumer that will call methods on ListDocumentClassificationJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDocumentClassificationJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobs

      default CompletableFuture<ListDocumentClassificationJobsResponse> listDocumentClassificationJobs()

      Gets a list of the documentation classification jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListDocumentClassificationJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobsPaginator

      default ListDocumentClassificationJobsPublisher listDocumentClassificationJobsPaginator()

      This is a variant of listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) 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.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse 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 listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobsPaginator

      default ListDocumentClassificationJobsPublisher listDocumentClassificationJobsPaginator(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)

      This is a variant of listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) 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.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse 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 listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) operation.

      Parameters:
      listDocumentClassificationJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassificationJobsPaginator

      default ListDocumentClassificationJobsPublisher listDocumentClassificationJobsPaginator(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest)

      This is a variant of listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) 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.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsPublisher publisher = client.listDocumentClassificationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse 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 listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest) operation.


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

      Parameters:
      listDocumentClassificationJobsRequest - A Consumer that will call methods on ListDocumentClassificationJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifierSummaries

      default CompletableFuture<ListDocumentClassifierSummariesResponse> listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest)

      Gets a list of summaries of the document classifiers that you have created

      Parameters:
      listDocumentClassifierSummariesRequest -
      Returns:
      A Java Future containing the result of the ListDocumentClassifierSummaries 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifierSummaries

      default CompletableFuture<ListDocumentClassifierSummariesResponse> listDocumentClassifierSummaries(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest)

      Gets a list of summaries of the document classifiers that you have created


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

      Parameters:
      listDocumentClassifierSummariesRequest - A Consumer that will call methods on ListDocumentClassifierSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDocumentClassifierSummaries 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifierSummariesPaginator

      default ListDocumentClassifierSummariesPublisher listDocumentClassifierSummariesPaginator(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest)

      This is a variant of listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest) 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.comprehend.paginators.ListDocumentClassifierSummariesPublisher publisher = client.listDocumentClassifierSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesPublisher publisher = client.listDocumentClassifierSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse 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 listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest) operation.

      Parameters:
      listDocumentClassifierSummariesRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifierSummariesPaginator

      default ListDocumentClassifierSummariesPublisher listDocumentClassifierSummariesPaginator(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest)

      This is a variant of listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest) 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.comprehend.paginators.ListDocumentClassifierSummariesPublisher publisher = client.listDocumentClassifierSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesPublisher publisher = client.listDocumentClassifierSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse 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 listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest) operation.


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

      Parameters:
      listDocumentClassifierSummariesRequest - A Consumer that will call methods on ListDocumentClassifierSummariesRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiers

      default CompletableFuture<ListDocumentClassifiersResponse> listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest)

      Gets a list of the document classifiers that you have created.

      Parameters:
      listDocumentClassifiersRequest -
      Returns:
      A Java Future containing the result of the ListDocumentClassifiers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiers

      default CompletableFuture<ListDocumentClassifiersResponse> listDocumentClassifiers(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest)

      Gets a list of the document classifiers that you have created.


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

      Parameters:
      listDocumentClassifiersRequest - A Consumer that will call methods on ListDocumentClassifiersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDocumentClassifiers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiers

      default CompletableFuture<ListDocumentClassifiersResponse> listDocumentClassifiers()

      Gets a list of the document classifiers that you have created.

      Returns:
      A Java Future containing the result of the ListDocumentClassifiers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiersPaginator

      default ListDocumentClassifiersPublisher listDocumentClassifiersPaginator()

      This is a variant of listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) 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.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse 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 listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiersPaginator

      default ListDocumentClassifiersPublisher listDocumentClassifiersPaginator(ListDocumentClassifiersRequest listDocumentClassifiersRequest)

      This is a variant of listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) 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.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse 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 listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) operation.

      Parameters:
      listDocumentClassifiersRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentClassifiersPaginator

      default ListDocumentClassifiersPublisher listDocumentClassifiersPaginator(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest)

      This is a variant of listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) 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.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersPublisher publisher = client.listDocumentClassifiersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse 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 listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest) operation.


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

      Parameters:
      listDocumentClassifiersRequest - A Consumer that will call methods on ListDocumentClassifiersRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobs

      default CompletableFuture<ListDominantLanguageDetectionJobsResponse> listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)

      Gets a list of the dominant language detection jobs that you have submitted.

      Parameters:
      listDominantLanguageDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListDominantLanguageDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobs

      default CompletableFuture<ListDominantLanguageDetectionJobsResponse> listDominantLanguageDetectionJobs(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest)

      Gets a list of the dominant language detection jobs that you have submitted.


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

      Parameters:
      listDominantLanguageDetectionJobsRequest - A Consumer that will call methods on ListDominantLanguageDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDominantLanguageDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobs

      default CompletableFuture<ListDominantLanguageDetectionJobsResponse> listDominantLanguageDetectionJobs()

      Gets a list of the dominant language detection jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListDominantLanguageDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobsPaginator

      default ListDominantLanguageDetectionJobsPublisher listDominantLanguageDetectionJobsPaginator()

      This is a variant of listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) 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.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse 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 listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobsPaginator

      default ListDominantLanguageDetectionJobsPublisher listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)

      This is a variant of listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) 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.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse 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 listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) operation.

      Parameters:
      listDominantLanguageDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDominantLanguageDetectionJobsPaginator

      default ListDominantLanguageDetectionJobsPublisher listDominantLanguageDetectionJobsPaginator(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest)

      This is a variant of listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) 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.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsPublisher publisher = client.listDominantLanguageDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse 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 listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest) operation.


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

      Parameters:
      listDominantLanguageDetectionJobsRequest - A Consumer that will call methods on ListDominantLanguageDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(ListEndpointsRequest listEndpointsRequest)

      Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

      Parameters:
      listEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListEndpoints 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEndpoints 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) 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.comprehend.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse 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 listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) operation.

      Parameters:
      listEndpointsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) 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.comprehend.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse 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 listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) operation.


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobs

      default CompletableFuture<ListEntitiesDetectionJobsResponse> listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)

      Gets a list of the entity detection jobs that you have submitted.

      Parameters:
      listEntitiesDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListEntitiesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobs

      default CompletableFuture<ListEntitiesDetectionJobsResponse> listEntitiesDetectionJobs(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest)

      Gets a list of the entity detection jobs that you have submitted.


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

      Parameters:
      listEntitiesDetectionJobsRequest - A Consumer that will call methods on ListEntitiesDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntitiesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobs

      default CompletableFuture<ListEntitiesDetectionJobsResponse> listEntitiesDetectionJobs()

      Gets a list of the entity detection jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListEntitiesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobsPaginator

      default ListEntitiesDetectionJobsPublisher listEntitiesDetectionJobsPaginator()

      This is a variant of listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) 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.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse 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 listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobsPaginator

      default ListEntitiesDetectionJobsPublisher listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)

      This is a variant of listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) 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.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse 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 listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) operation.

      Parameters:
      listEntitiesDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntitiesDetectionJobsPaginator

      default ListEntitiesDetectionJobsPublisher listEntitiesDetectionJobsPaginator(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest)

      This is a variant of listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) 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.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsPublisher publisher = client.listEntitiesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse 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 listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest) operation.


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

      Parameters:
      listEntitiesDetectionJobsRequest - A Consumer that will call methods on ListEntitiesDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizerSummaries

      default CompletableFuture<ListEntityRecognizerSummariesResponse> listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest)

      Gets a list of summaries for the entity recognizers that you have created.

      Parameters:
      listEntityRecognizerSummariesRequest -
      Returns:
      A Java Future containing the result of the ListEntityRecognizerSummaries 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizerSummaries

      default CompletableFuture<ListEntityRecognizerSummariesResponse> listEntityRecognizerSummaries(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest)

      Gets a list of summaries for the entity recognizers that you have created.


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

      Parameters:
      listEntityRecognizerSummariesRequest - A Consumer that will call methods on ListEntityRecognizerSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntityRecognizerSummaries 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizerSummariesPaginator

      default ListEntityRecognizerSummariesPublisher listEntityRecognizerSummariesPaginator(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest)

      This is a variant of listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest) 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.comprehend.paginators.ListEntityRecognizerSummariesPublisher publisher = client.listEntityRecognizerSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesPublisher publisher = client.listEntityRecognizerSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse 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 listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest) operation.

      Parameters:
      listEntityRecognizerSummariesRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizerSummariesPaginator

      default ListEntityRecognizerSummariesPublisher listEntityRecognizerSummariesPaginator(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest)

      This is a variant of listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest) 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.comprehend.paginators.ListEntityRecognizerSummariesPublisher publisher = client.listEntityRecognizerSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesPublisher publisher = client.listEntityRecognizerSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse 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 listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest) operation.


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

      Parameters:
      listEntityRecognizerSummariesRequest - A Consumer that will call methods on ListEntityRecognizerSummariesRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizers

      default CompletableFuture<ListEntityRecognizersResponse> listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest)

      Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

      The results of this list are not in any particular order. Please get the list and sort locally if needed.

      Parameters:
      listEntityRecognizersRequest -
      Returns:
      A Java Future containing the result of the ListEntityRecognizers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizers

      default CompletableFuture<ListEntityRecognizersResponse> listEntityRecognizers(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest)

      Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

      The results of this list are not in any particular order. Please get the list and sort locally if needed.


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

      Parameters:
      listEntityRecognizersRequest - A Consumer that will call methods on ListEntityRecognizersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntityRecognizers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizers

      default CompletableFuture<ListEntityRecognizersResponse> listEntityRecognizers()

      Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

      The results of this list are not in any particular order. Please get the list and sort locally if needed.

      Returns:
      A Java Future containing the result of the ListEntityRecognizers 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizersPaginator

      default ListEntityRecognizersPublisher listEntityRecognizersPaginator()

      This is a variant of listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) 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.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse 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 listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizersPaginator

      default ListEntityRecognizersPublisher listEntityRecognizersPaginator(ListEntityRecognizersRequest listEntityRecognizersRequest)

      This is a variant of listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) 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.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse 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 listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) operation.

      Parameters:
      listEntityRecognizersRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityRecognizersPaginator

      default ListEntityRecognizersPublisher listEntityRecognizersPaginator(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest)

      This is a variant of listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) 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.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersPublisher publisher = client.listEntityRecognizersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse 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 listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest) operation.


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

      Parameters:
      listEntityRecognizersRequest - A Consumer that will call methods on ListEntityRecognizersRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEventsDetectionJobs

      default CompletableFuture<ListEventsDetectionJobsResponse> listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)

      Gets a list of the events detection jobs that you have submitted.

      Parameters:
      listEventsDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListEventsDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEventsDetectionJobs

      default CompletableFuture<ListEventsDetectionJobsResponse> listEventsDetectionJobs(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest)

      Gets a list of the events detection jobs that you have submitted.


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

      Parameters:
      listEventsDetectionJobsRequest - A Consumer that will call methods on ListEventsDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEventsDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEventsDetectionJobsPaginator

      default ListEventsDetectionJobsPublisher listEventsDetectionJobsPaginator(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)

      This is a variant of listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest) 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.comprehend.paginators.ListEventsDetectionJobsPublisher publisher = client.listEventsDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsPublisher publisher = client.listEventsDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse 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 listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest) operation.

      Parameters:
      listEventsDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEventsDetectionJobsPaginator

      default ListEventsDetectionJobsPublisher listEventsDetectionJobsPaginator(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest)

      This is a variant of listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest) 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.comprehend.paginators.ListEventsDetectionJobsPublisher publisher = client.listEventsDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsPublisher publisher = client.listEventsDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse 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 listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest) operation.


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

      Parameters:
      listEventsDetectionJobsRequest - A Consumer that will call methods on ListEventsDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelIterationHistory

      default CompletableFuture<ListFlywheelIterationHistoryResponse> listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest)

      Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      listFlywheelIterationHistoryRequest -
      Returns:
      A Java Future containing the result of the ListFlywheelIterationHistory 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelIterationHistory

      default CompletableFuture<ListFlywheelIterationHistoryResponse> listFlywheelIterationHistory(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest)

      Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      listFlywheelIterationHistoryRequest - A Consumer that will call methods on ListFlywheelIterationHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlywheelIterationHistory 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelIterationHistoryPaginator

      default ListFlywheelIterationHistoryPublisher listFlywheelIterationHistoryPaginator(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest)

      This is a variant of listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest) 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.comprehend.paginators.ListFlywheelIterationHistoryPublisher publisher = client.listFlywheelIterationHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryPublisher publisher = client.listFlywheelIterationHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse 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 listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest) operation.

      Parameters:
      listFlywheelIterationHistoryRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelIterationHistoryPaginator

      default ListFlywheelIterationHistoryPublisher listFlywheelIterationHistoryPaginator(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest)

      This is a variant of listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest) 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.comprehend.paginators.ListFlywheelIterationHistoryPublisher publisher = client.listFlywheelIterationHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryPublisher publisher = client.listFlywheelIterationHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse 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 listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest) operation.


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

      Parameters:
      listFlywheelIterationHistoryRequest - A Consumer that will call methods on ListFlywheelIterationHistoryRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheels

      default CompletableFuture<ListFlywheelsResponse> listFlywheels(ListFlywheelsRequest listFlywheelsRequest)

      Gets a list of the flywheels that you have created.

      Parameters:
      listFlywheelsRequest -
      Returns:
      A Java Future containing the result of the ListFlywheels 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheels

      default CompletableFuture<ListFlywheelsResponse> listFlywheels(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest)

      Gets a list of the flywheels that you have created.


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

      Parameters:
      listFlywheelsRequest - A Consumer that will call methods on ListFlywheelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlywheels 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelsPaginator

      default ListFlywheelsPublisher listFlywheelsPaginator(ListFlywheelsRequest listFlywheelsRequest)

      This is a variant of listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) 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.comprehend.paginators.ListFlywheelsPublisher publisher = client.listFlywheelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsPublisher publisher = client.listFlywheelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse 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 listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) operation.

      Parameters:
      listFlywheelsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlywheelsPaginator

      default ListFlywheelsPublisher listFlywheelsPaginator(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest)

      This is a variant of listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) 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.comprehend.paginators.ListFlywheelsPublisher publisher = client.listFlywheelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsPublisher publisher = client.listFlywheelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse 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 listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) operation.


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

      Parameters:
      listFlywheelsRequest - A Consumer that will call methods on ListFlywheelsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobs

      default CompletableFuture<ListKeyPhrasesDetectionJobsResponse> listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)

      Get a list of key phrase detection jobs that you have submitted.

      Parameters:
      listKeyPhrasesDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListKeyPhrasesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobs

      default CompletableFuture<ListKeyPhrasesDetectionJobsResponse> listKeyPhrasesDetectionJobs(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest)

      Get a list of key phrase detection jobs that you have submitted.


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

      Parameters:
      listKeyPhrasesDetectionJobsRequest - A Consumer that will call methods on ListKeyPhrasesDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListKeyPhrasesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobs

      default CompletableFuture<ListKeyPhrasesDetectionJobsResponse> listKeyPhrasesDetectionJobs()

      Get a list of key phrase detection jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListKeyPhrasesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobsPaginator

      default ListKeyPhrasesDetectionJobsPublisher listKeyPhrasesDetectionJobsPaginator()

      This is a variant of listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) 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.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse 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 listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobsPaginator

      default ListKeyPhrasesDetectionJobsPublisher listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)

      This is a variant of listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) 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.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse 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 listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) operation.

      Parameters:
      listKeyPhrasesDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKeyPhrasesDetectionJobsPaginator

      default ListKeyPhrasesDetectionJobsPublisher listKeyPhrasesDetectionJobsPaginator(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest)

      This is a variant of listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) 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.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsPublisher publisher = client.listKeyPhrasesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse 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 listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest) operation.


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

      Parameters:
      listKeyPhrasesDetectionJobsRequest - A Consumer that will call methods on ListKeyPhrasesDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPiiEntitiesDetectionJobs

      default CompletableFuture<ListPiiEntitiesDetectionJobsResponse> listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)

      Gets a list of the PII entity detection jobs that you have submitted.

      Parameters:
      listPiiEntitiesDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListPiiEntitiesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPiiEntitiesDetectionJobs

      default CompletableFuture<ListPiiEntitiesDetectionJobsResponse> listPiiEntitiesDetectionJobs(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest)

      Gets a list of the PII entity detection jobs that you have submitted.


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

      Parameters:
      listPiiEntitiesDetectionJobsRequest - A Consumer that will call methods on ListPiiEntitiesDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPiiEntitiesDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPiiEntitiesDetectionJobsPaginator

      default ListPiiEntitiesDetectionJobsPublisher listPiiEntitiesDetectionJobsPaginator(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)

      This is a variant of listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest) 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.comprehend.paginators.ListPiiEntitiesDetectionJobsPublisher publisher = client.listPiiEntitiesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsPublisher publisher = client.listPiiEntitiesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse 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 listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest) operation.

      Parameters:
      listPiiEntitiesDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPiiEntitiesDetectionJobsPaginator

      default ListPiiEntitiesDetectionJobsPublisher listPiiEntitiesDetectionJobsPaginator(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest)

      This is a variant of listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest) 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.comprehend.paginators.ListPiiEntitiesDetectionJobsPublisher publisher = client.listPiiEntitiesDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsPublisher publisher = client.listPiiEntitiesDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse 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 listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest) operation.


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

      Parameters:
      listPiiEntitiesDetectionJobsRequest - A Consumer that will call methods on ListPiiEntitiesDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobs

      default CompletableFuture<ListSentimentDetectionJobsResponse> listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)

      Gets a list of sentiment detection jobs that you have submitted.

      Parameters:
      listSentimentDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListSentimentDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobs

      default CompletableFuture<ListSentimentDetectionJobsResponse> listSentimentDetectionJobs(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest)

      Gets a list of sentiment detection jobs that you have submitted.


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

      Parameters:
      listSentimentDetectionJobsRequest - A Consumer that will call methods on ListSentimentDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSentimentDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobs

      default CompletableFuture<ListSentimentDetectionJobsResponse> listSentimentDetectionJobs()

      Gets a list of sentiment detection jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListSentimentDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobsPaginator

      default ListSentimentDetectionJobsPublisher listSentimentDetectionJobsPaginator()

      This is a variant of listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) 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.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse 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 listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobsPaginator

      default ListSentimentDetectionJobsPublisher listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)

      This is a variant of listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) 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.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse 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 listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) operation.

      Parameters:
      listSentimentDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSentimentDetectionJobsPaginator

      default ListSentimentDetectionJobsPublisher listSentimentDetectionJobsPaginator(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest)

      This is a variant of listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) 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.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsPublisher publisher = client.listSentimentDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse 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 listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest) operation.


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

      Parameters:
      listSentimentDetectionJobsRequest - A Consumer that will call methods on ListSentimentDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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 all tags associated with a given Amazon Comprehend 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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 all tags associated with a given Amazon Comprehend 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTargetedSentimentDetectionJobs

      default CompletableFuture<ListTargetedSentimentDetectionJobsResponse> listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest)

      Gets a list of targeted sentiment detection jobs that you have submitted.

      Parameters:
      listTargetedSentimentDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListTargetedSentimentDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTargetedSentimentDetectionJobs

      default CompletableFuture<ListTargetedSentimentDetectionJobsResponse> listTargetedSentimentDetectionJobs(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest)

      Gets a list of targeted sentiment detection jobs that you have submitted.


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

      Parameters:
      listTargetedSentimentDetectionJobsRequest - A Consumer that will call methods on ListTargetedSentimentDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTargetedSentimentDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTargetedSentimentDetectionJobsPaginator

      default ListTargetedSentimentDetectionJobsPublisher listTargetedSentimentDetectionJobsPaginator(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest)

      This is a variant of listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest) 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.comprehend.paginators.ListTargetedSentimentDetectionJobsPublisher publisher = client.listTargetedSentimentDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsPublisher publisher = client.listTargetedSentimentDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse 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 listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest) operation.

      Parameters:
      listTargetedSentimentDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTargetedSentimentDetectionJobsPaginator

      default ListTargetedSentimentDetectionJobsPublisher listTargetedSentimentDetectionJobsPaginator(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest)

      This is a variant of listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest) 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.comprehend.paginators.ListTargetedSentimentDetectionJobsPublisher publisher = client.listTargetedSentimentDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsPublisher publisher = client.listTargetedSentimentDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse 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 listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest) operation.


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

      Parameters:
      listTargetedSentimentDetectionJobsRequest - A Consumer that will call methods on ListTargetedSentimentDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobs

      default CompletableFuture<ListTopicsDetectionJobsResponse> listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)

      Gets a list of the topic detection jobs that you have submitted.

      Parameters:
      listTopicsDetectionJobsRequest -
      Returns:
      A Java Future containing the result of the ListTopicsDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobs

      default CompletableFuture<ListTopicsDetectionJobsResponse> listTopicsDetectionJobs(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest)

      Gets a list of the topic detection jobs that you have submitted.


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

      Parameters:
      listTopicsDetectionJobsRequest - A Consumer that will call methods on ListTopicsDetectionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTopicsDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobs

      default CompletableFuture<ListTopicsDetectionJobsResponse> listTopicsDetectionJobs()

      Gets a list of the topic detection jobs that you have submitted.

      Returns:
      A Java Future containing the result of the ListTopicsDetectionJobs 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobsPaginator

      default ListTopicsDetectionJobsPublisher listTopicsDetectionJobsPaginator()

      This is a variant of listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) 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.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse 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 listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) operation.

      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobsPaginator

      default ListTopicsDetectionJobsPublisher listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)

      This is a variant of listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) 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.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse 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 listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) operation.

      Parameters:
      listTopicsDetectionJobsRequest -
      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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTopicsDetectionJobsPaginator

      default ListTopicsDetectionJobsPublisher listTopicsDetectionJobsPaginator(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest)

      This is a variant of listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) 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.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsPublisher publisher = client.listTopicsDetectionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse 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 listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest) operation.


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

      Parameters:
      listTopicsDetectionJobsRequest - A Consumer that will call methods on ListTopicsDetectionJobsRequest.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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

      Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

      Parameters:
      putResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the PutResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

      Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.


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

      Parameters:
      putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutResourcePolicy 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.
      • InvalidRequestException The request is invalid.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDocumentClassificationJob

      default CompletableFuture<StartDocumentClassificationJobResponse> startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest)

      Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

      Parameters:
      startDocumentClassificationJobRequest -
      Returns:
      A Java Future containing the result of the StartDocumentClassificationJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDocumentClassificationJob

      default CompletableFuture<StartDocumentClassificationJobResponse> startDocumentClassificationJob(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest)

      Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.


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

      Parameters:
      startDocumentClassificationJobRequest - A Consumer that will call methods on StartDocumentClassificationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDocumentClassificationJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDominantLanguageDetectionJob

      default CompletableFuture<StartDominantLanguageDetectionJobResponse> startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)

      Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

      Parameters:
      startDominantLanguageDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDominantLanguageDetectionJob

      default CompletableFuture<StartDominantLanguageDetectionJobResponse> startDominantLanguageDetectionJob(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest)

      Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.


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

      Parameters:
      startDominantLanguageDetectionJobRequest - A Consumer that will call methods on StartDominantLanguageDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEntitiesDetectionJob

      default CompletableFuture<StartEntitiesDetectionJobResponse> startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)

      Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

      This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

      Parameters:
      startEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEntitiesDetectionJob

      default CompletableFuture<StartEntitiesDetectionJobResponse> startEntitiesDetectionJob(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest)

      Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

      This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.


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

      Parameters:
      startEntitiesDetectionJobRequest - A Consumer that will call methods on StartEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEventsDetectionJob

      default CompletableFuture<StartEventsDetectionJobResponse> startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest)

      Starts an asynchronous event detection job for a collection of documents.

      Parameters:
      startEventsDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEventsDetectionJob

      default CompletableFuture<StartEventsDetectionJobResponse> startEventsDetectionJob(Consumer<StartEventsDetectionJobRequest.Builder> startEventsDetectionJobRequest)

      Starts an asynchronous event detection job for a collection of documents.


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

      Parameters:
      startEventsDetectionJobRequest - A Consumer that will call methods on StartEventsDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFlywheelIteration

      default CompletableFuture<StartFlywheelIterationResponse> startFlywheelIteration(StartFlywheelIterationRequest startFlywheelIterationRequest)

      Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

      Parameters:
      startFlywheelIterationRequest -
      Returns:
      A Java Future containing the result of the StartFlywheelIteration 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFlywheelIteration

      default CompletableFuture<StartFlywheelIterationResponse> startFlywheelIteration(Consumer<StartFlywheelIterationRequest.Builder> startFlywheelIterationRequest)

      Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.


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

      Parameters:
      startFlywheelIterationRequest - A Consumer that will call methods on StartFlywheelIterationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartFlywheelIteration 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startKeyPhrasesDetectionJob

      default CompletableFuture<StartKeyPhrasesDetectionJobResponse> startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)

      Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

      Parameters:
      startKeyPhrasesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startKeyPhrasesDetectionJob

      default CompletableFuture<StartKeyPhrasesDetectionJobResponse> startKeyPhrasesDetectionJob(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest)

      Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.


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

      Parameters:
      startKeyPhrasesDetectionJobRequest - A Consumer that will call methods on StartKeyPhrasesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPiiEntitiesDetectionJob

      default CompletableFuture<StartPiiEntitiesDetectionJobResponse> startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest)

      Starts an asynchronous PII entity detection job for a collection of documents.

      Parameters:
      startPiiEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartPiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPiiEntitiesDetectionJob

      default CompletableFuture<StartPiiEntitiesDetectionJobResponse> startPiiEntitiesDetectionJob(Consumer<StartPiiEntitiesDetectionJobRequest.Builder> startPiiEntitiesDetectionJobRequest)

      Starts an asynchronous PII entity detection job for a collection of documents.


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

      Parameters:
      startPiiEntitiesDetectionJobRequest - A Consumer that will call methods on StartPiiEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartPiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSentimentDetectionJob

      default CompletableFuture<StartSentimentDetectionJobResponse> startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)

      Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

      Parameters:
      startSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSentimentDetectionJob

      default CompletableFuture<StartSentimentDetectionJobResponse> startSentimentDetectionJob(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest)

      Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.


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

      Parameters:
      startSentimentDetectionJobRequest - A Consumer that will call methods on StartSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTargetedSentimentDetectionJob

      default CompletableFuture<StartTargetedSentimentDetectionJobResponse> startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest)

      Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.

      Parameters:
      startTargetedSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTargetedSentimentDetectionJob

      default CompletableFuture<StartTargetedSentimentDetectionJobResponse> startTargetedSentimentDetectionJob(Consumer<StartTargetedSentimentDetectionJobRequest.Builder> startTargetedSentimentDetectionJobRequest)

      Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.


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

      Parameters:
      startTargetedSentimentDetectionJobRequest - A Consumer that will call methods on StartTargetedSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTopicsDetectionJob

      default CompletableFuture<StartTopicsDetectionJobResponse> startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)

      Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

      Parameters:
      startTopicsDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StartTopicsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTopicsDetectionJob

      default CompletableFuture<StartTopicsDetectionJobResponse> startTopicsDetectionJob(Consumer<StartTopicsDetectionJobRequest.Builder> startTopicsDetectionJobRequest)

      Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.


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

      Parameters:
      startTopicsDetectionJobRequest - A Consumer that will call methods on StartTopicsDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTopicsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDominantLanguageDetectionJob

      default CompletableFuture<StopDominantLanguageDetectionJobResponse> stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)

      Stops a dominant language detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.

      Parameters:
      stopDominantLanguageDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDominantLanguageDetectionJob

      default CompletableFuture<StopDominantLanguageDetectionJobResponse> stopDominantLanguageDetectionJob(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest)

      Stops a dominant language detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.


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

      Parameters:
      stopDominantLanguageDetectionJobRequest - A Consumer that will call methods on StopDominantLanguageDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopDominantLanguageDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEntitiesDetectionJob

      default CompletableFuture<StopEntitiesDetectionJobResponse> stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)

      Stops an entities detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.

      Parameters:
      stopEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEntitiesDetectionJob

      default CompletableFuture<StopEntitiesDetectionJobResponse> stopEntitiesDetectionJob(Consumer<StopEntitiesDetectionJobRequest.Builder> stopEntitiesDetectionJobRequest)

      Stops an entities detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.


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

      Parameters:
      stopEntitiesDetectionJobRequest - A Consumer that will call methods on StopEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEventsDetectionJob

      default CompletableFuture<StopEventsDetectionJobResponse> stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest)

      Stops an events detection job in progress.

      Parameters:
      stopEventsDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEventsDetectionJob

      default CompletableFuture<StopEventsDetectionJobResponse> stopEventsDetectionJob(Consumer<StopEventsDetectionJobRequest.Builder> stopEventsDetectionJobRequest)

      Stops an events detection job in progress.


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

      Parameters:
      stopEventsDetectionJobRequest - A Consumer that will call methods on StopEventsDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopEventsDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopKeyPhrasesDetectionJob

      default CompletableFuture<StopKeyPhrasesDetectionJobResponse> stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)

      Stops a key phrases detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.

      Parameters:
      stopKeyPhrasesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopKeyPhrasesDetectionJob

      default CompletableFuture<StopKeyPhrasesDetectionJobResponse> stopKeyPhrasesDetectionJob(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest)

      Stops a key phrases detection job in progress.

      If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.


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

      Parameters:
      stopKeyPhrasesDetectionJobRequest - A Consumer that will call methods on StopKeyPhrasesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopKeyPhrasesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPiiEntitiesDetectionJob

      default CompletableFuture<StopPiiEntitiesDetectionJobResponse> stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest)

      Stops a PII entities detection job in progress.

      Parameters:
      stopPiiEntitiesDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopPiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPiiEntitiesDetectionJob

      default CompletableFuture<StopPiiEntitiesDetectionJobResponse> stopPiiEntitiesDetectionJob(Consumer<StopPiiEntitiesDetectionJobRequest.Builder> stopPiiEntitiesDetectionJobRequest)

      Stops a PII entities detection job in progress.


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

      Parameters:
      stopPiiEntitiesDetectionJobRequest - A Consumer that will call methods on StopPiiEntitiesDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopPiiEntitiesDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSentimentDetectionJob

      default CompletableFuture<StopSentimentDetectionJobResponse> stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)

      Stops a sentiment detection job in progress.

      If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.

      Parameters:
      stopSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSentimentDetectionJob

      default CompletableFuture<StopSentimentDetectionJobResponse> stopSentimentDetectionJob(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest)

      Stops a sentiment detection job in progress.

      If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.


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

      Parameters:
      stopSentimentDetectionJobRequest - A Consumer that will call methods on StopSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTargetedSentimentDetectionJob

      default CompletableFuture<StopTargetedSentimentDetectionJobResponse> stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest)

      Stops a targeted sentiment detection job in progress.

      If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.

      Parameters:
      stopTargetedSentimentDetectionJobRequest -
      Returns:
      A Java Future containing the result of the StopTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTargetedSentimentDetectionJob

      default CompletableFuture<StopTargetedSentimentDetectionJobResponse> stopTargetedSentimentDetectionJob(Consumer<StopTargetedSentimentDetectionJobRequest.Builder> stopTargetedSentimentDetectionJobRequest)

      Stops a targeted sentiment detection job in progress.

      If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

      If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

      When a job is stopped, any documents already processed are written to the output location.


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

      Parameters:
      stopTargetedSentimentDetectionJobRequest - A Consumer that will call methods on StopTargetedSentimentDetectionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTargetedSentimentDetectionJob 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.
      • InvalidRequestException The request is invalid.
      • JobNotFoundException The specified job was not found. Check the job ID and try again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingDocumentClassifier

      default CompletableFuture<StopTrainingDocumentClassifierResponse> stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest)

      Stops a document classifier training job while in progress.

      If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

      Parameters:
      stopTrainingDocumentClassifierRequest -
      Returns:
      A Java Future containing the result of the StopTrainingDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingDocumentClassifier

      default CompletableFuture<StopTrainingDocumentClassifierResponse> stopTrainingDocumentClassifier(Consumer<StopTrainingDocumentClassifierRequest.Builder> stopTrainingDocumentClassifierRequest)

      Stops a document classifier training job while in progress.

      If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.


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

      Parameters:
      stopTrainingDocumentClassifierRequest - A Consumer that will call methods on StopTrainingDocumentClassifierRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTrainingDocumentClassifier 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingEntityRecognizer

      default CompletableFuture<StopTrainingEntityRecognizerResponse> stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest)

      Stops an entity recognizer training job while in progress.

      If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

      Parameters:
      stopTrainingEntityRecognizerRequest -
      Returns:
      A Java Future containing the result of the StopTrainingEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingEntityRecognizer

      default CompletableFuture<StopTrainingEntityRecognizerResponse> stopTrainingEntityRecognizer(Consumer<StopTrainingEntityRecognizerRequest.Builder> stopTrainingEntityRecognizerRequest)

      Stops an entity recognizer training job while in progress.

      If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.


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

      Parameters:
      stopTrainingEntityRecognizerRequest - A Consumer that will call methods on StopTrainingEntityRecognizerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTrainingEntityRecognizer 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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)

      Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

      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.
      • InvalidRequestException The request is invalid.
      • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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)

      Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.


      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.
      • InvalidRequestException The request is invalid.
      • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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)

      Removes a specific tag associated with an Amazon Comprehend 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.
      • TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
      • InvalidRequestException The request is invalid.
      • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException 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)

      Removes a specific tag associated with an Amazon Comprehend 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.
      • TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
      • InvalidRequestException The request is invalid.
      • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

      Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

      Parameters:
      updateEndpointRequest -
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest)

      Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.


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

      Parameters:
      updateEndpointRequest - A Consumer that will call methods on UpdateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
      • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlywheel

      default CompletableFuture<UpdateFlywheelResponse> updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest)

      Update the configuration information for an existing flywheel.

      Parameters:
      updateFlywheelRequest -
      Returns:
      A Java Future containing the result of the UpdateFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlywheel

      default CompletableFuture<UpdateFlywheelResponse> updateFlywheel(Consumer<UpdateFlywheelRequest.Builder> updateFlywheelRequest)

      Update the configuration information for an existing flywheel.


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

      Parameters:
      updateFlywheelRequest - A Consumer that will call methods on UpdateFlywheelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFlywheel 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.
      • InvalidRequestException The request is invalid.
      • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
      • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
      • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
      • InternalServerException An internal server error occurred. Retry your request.
      • 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.
      • ComprehendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ComprehendServiceClientConfiguration 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 ComprehendAsyncClient create()
      Create a ComprehendAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ComprehendAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ComprehendAsyncClient.