Interface ComprehendClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ComprehendClient extends AwsClient
Service client for accessing Amazon Comprehend. This can be created using the staticbuilder()method.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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchDetectDominantLanguage
default BatchDetectDominantLanguageResponse batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the BatchDetectDominantLanguage operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectDominantLanguage
default BatchDetectDominantLanguageResponse batchDetectDominantLanguage(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaBatchDetectDominantLanguageRequest.builder()- Parameters:
batchDetectDominantLanguageRequest- AConsumerthat will call methods onBatchDetectDominantLanguageRequest.Builderto create a request.- Returns:
- Result of the BatchDetectDominantLanguage operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectEntities
default BatchDetectEntitiesResponse batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the BatchDetectEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectEntities
default BatchDetectEntitiesResponse batchDetectEntities(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaBatchDetectEntitiesRequest.builder()- Parameters:
batchDetectEntitiesRequest- AConsumerthat will call methods onBatchDetectEntitiesRequest.Builderto create a request.- Returns:
- Result of the BatchDetectEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectKeyPhrases
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in a batch of documents.
- Parameters:
batchDetectKeyPhrasesRequest-- Returns:
- Result of the BatchDetectKeyPhrases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectKeyPhrases
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in a batch of documents.
This is a convenience which creates an instance of the
BatchDetectKeyPhrasesRequest.Builderavoiding the need to create one manually viaBatchDetectKeyPhrasesRequest.builder()- Parameters:
batchDetectKeyPhrasesRequest- AConsumerthat will call methods onBatchDetectKeyPhrasesRequest.Builderto create a request.- Returns:
- Result of the BatchDetectKeyPhrases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectSentiment
default BatchDetectSentimentResponse batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE,NEUTRAL,MIXED, orNEGATIVE, in each one.- Parameters:
batchDetectSentimentRequest-- Returns:
- Result of the BatchDetectSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectSentiment
default BatchDetectSentimentResponse batchDetectSentiment(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE,NEUTRAL,MIXED, orNEGATIVE, in each one.
This is a convenience which creates an instance of the
BatchDetectSentimentRequest.Builderavoiding the need to create one manually viaBatchDetectSentimentRequest.builder()- Parameters:
batchDetectSentimentRequest- AConsumerthat will call methods onBatchDetectSentimentRequest.Builderto create a request.- Returns:
- Result of the BatchDetectSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectSyntax
default BatchDetectSyntaxResponse batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the BatchDetectSyntax operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectSyntax
default BatchDetectSyntaxResponse batchDetectSyntax(Consumer<BatchDetectSyntaxRequest.Builder> batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaBatchDetectSyntaxRequest.builder()- Parameters:
batchDetectSyntaxRequest- AConsumerthat will call methods onBatchDetectSyntaxRequest.Builderto create a request.- Returns:
- Result of the BatchDetectSyntax operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectTargetedSentiment
default BatchDetectTargetedSentimentResponse batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the BatchDetectTargetedSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDetectTargetedSentiment
default BatchDetectTargetedSentimentResponse batchDetectTargetedSentiment(Consumer<BatchDetectTargetedSentimentRequest.Builder> batchDetectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaBatchDetectTargetedSentimentRequest.builder()- Parameters:
batchDetectTargetedSentimentRequest- AConsumerthat will call methods onBatchDetectTargetedSentimentRequest.Builderto create a request.- Returns:
- Result of the BatchDetectTargetedSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
classifyDocument
default ClassifyDocumentResponse classifyDocument(ClassifyDocumentRequest classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a classification request to analyze a single document in real-time.
ClassifyDocumentsupports 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
Classesfield. 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
Errorsfield that describes the errors.If the system detects a document-level error in your input document, the API returns an
InvalidRequestExceptionerror response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.- Parameters:
classifyDocumentRequest-- Returns:
- Result of the ClassifyDocument operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
classifyDocument
default ClassifyDocumentResponse classifyDocument(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a classification request to analyze a single document in real-time.
ClassifyDocumentsupports 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
Classesfield. 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
Errorsfield that describes the errors.If the system detects a document-level error in your input document, the API returns an
InvalidRequestExceptionerror 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.Builderavoiding the need to create one manually viaClassifyDocumentRequest.builder()- Parameters:
classifyDocumentRequest- AConsumerthat will call methods onClassifyDocumentRequest.Builderto create a request.- Returns:
- Result of the ClassifyDocument operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
containsPiiEntities
default ContainsPiiEntitiesResponse containsPiiEntities(ContainsPiiEntitiesRequest containsPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ContainsPiiEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
containsPiiEntities
default ContainsPiiEntitiesResponse containsPiiEntities(Consumer<ContainsPiiEntitiesRequest.Builder> containsPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaContainsPiiEntitiesRequest.builder()- Parameters:
containsPiiEntitiesRequest- AConsumerthat will call methods onContainsPiiEntitiesRequest.Builderto create a request.- Returns:
- Result of the ContainsPiiEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataset
default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the CreateDataset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataset
default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaCreateDatasetRequest.builder()- Parameters:
createDatasetRequest- AConsumerthat will call methods onCreateDatasetRequest.Builderto create a request.- Returns:
- Result of the CreateDataset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDocumentClassifier
default CreateDocumentClassifierResponse createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the CreateDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDocumentClassifier
default CreateDocumentClassifierResponse createDocumentClassifier(Consumer<CreateDocumentClassifierRequest.Builder> createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaCreateDocumentClassifierRequest.builder()- Parameters:
createDocumentClassifierRequest- AConsumerthat will call methods onCreateDocumentClassifierRequest.Builderto create a request.- Returns:
- Result of the CreateDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEndpoint
default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, TooManyRequestsException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
- Parameters:
createEndpointRequest-- Returns:
- Result of the CreateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEndpoint
default CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, TooManyRequestsException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaCreateEndpointRequest.builder()- Parameters:
createEndpointRequest- AConsumerthat will call methods onCreateEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEntityRecognizer
default CreateEntityRecognizerResponse createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your
CreateEntityRecognizerrequest is submitted, you can check job status using theDescribeEntityRecognizerAPI.- Parameters:
createEntityRecognizerRequest-- Returns:
- Result of the CreateEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEntityRecognizer
default CreateEntityRecognizerResponse createEntityRecognizer(Consumer<CreateEntityRecognizerRequest.Builder> createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your
CreateEntityRecognizerrequest is submitted, you can check job status using theDescribeEntityRecognizerAPI.
This is a convenience which creates an instance of the
CreateEntityRecognizerRequest.Builderavoiding the need to create one manually viaCreateEntityRecognizerRequest.builder()- Parameters:
createEntityRecognizerRequest- AConsumerthat will call methods onCreateEntityRecognizerRequest.Builderto create a request.- Returns:
- Result of the CreateEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlywheel
default CreateFlywheelResponse createFlywheel(CreateFlywheelRequest createFlywheelRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the CreateFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlywheel
default CreateFlywheelResponse createFlywheel(Consumer<CreateFlywheelRequest.Builder> createFlywheelRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaCreateFlywheelRequest.builder()- Parameters:
createFlywheelRequest- AConsumerthat will call methods onCreateFlywheelRequest.Builderto create a request.- Returns:
- Result of the CreateFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDocumentClassifier
default DeleteDocumentClassifierResponse deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
ResourceInUseExceptionwill 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:
- Result of the DeleteDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDocumentClassifier
default DeleteDocumentClassifierResponse deleteDocumentClassifier(Consumer<DeleteDocumentClassifierRequest.Builder> deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
ResourceInUseExceptionwill 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.Builderavoiding the need to create one manually viaDeleteDocumentClassifierRequest.builder()- Parameters:
deleteDocumentClassifierRequest- AConsumerthat will call methods onDeleteDocumentClassifierRequest.Builderto create a request.- Returns:
- Result of the DeleteDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DeleteEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDeleteEndpointRequest.builder()- Parameters:
deleteEndpointRequest- AConsumerthat will call methods onDeleteEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEntityRecognizer
default DeleteEntityRecognizerResponse deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
ResourceInUseExceptionwill 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:
- Result of the DeleteEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEntityRecognizer
default DeleteEntityRecognizerResponse deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
ResourceInUseExceptionwill 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.Builderavoiding the need to create one manually viaDeleteEntityRecognizerRequest.builder()- Parameters:
deleteEntityRecognizerRequest- AConsumerthat will call methods onDeleteEntityRecognizerRequest.Builderto create a request.- Returns:
- Result of the DeleteEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlywheel
default DeleteFlywheelResponse deleteFlywheel(DeleteFlywheelRequest deleteFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DeleteFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlywheel
default DeleteFlywheelResponse deleteFlywheel(Consumer<DeleteFlywheelRequest.Builder> deleteFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDeleteFlywheelRequest.builder()- Parameters:
deleteFlywheelRequest- AConsumerthat will call methods onDeleteFlywheelRequest.Builderto create a request.- Returns:
- Result of the DeleteFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a resource-based policy that is attached to a custom model.
- Parameters:
deleteResourcePolicyRequest-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a resource-based policy that is attached to a custom model.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builderavoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()- Parameters:
deleteResourcePolicyRequest- AConsumerthat will call methods onDeleteResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataset
default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DescribeDataset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataset
default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeDatasetRequest.builder()- Parameters:
describeDatasetRequest- AConsumerthat will call methods onDescribeDatasetRequest.Builderto create a request.- Returns:
- Result of the DescribeDataset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDocumentClassificationJob
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
- Parameters:
describeDocumentClassificationJobRequest-- Returns:
- Result of the DescribeDocumentClassificationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDocumentClassificationJob
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeDocumentClassificationJobRequest.builder()- Parameters:
describeDocumentClassificationJobRequest- AConsumerthat will call methods onDescribeDocumentClassificationJobRequest.Builderto create a request.- Returns:
- Result of the DescribeDocumentClassificationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDocumentClassifier
default DescribeDocumentClassifierResponse describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classifier.
- Parameters:
describeDocumentClassifierRequest-- Returns:
- Result of the DescribeDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDocumentClassifier
default DescribeDocumentClassifierResponse describeDocumentClassifier(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classifier.
This is a convenience which creates an instance of the
DescribeDocumentClassifierRequest.Builderavoiding the need to create one manually viaDescribeDocumentClassifierRequest.builder()- Parameters:
describeDocumentClassifierRequest- AConsumerthat will call methods onDescribeDocumentClassifierRequest.Builderto create a request.- Returns:
- Result of the DescribeDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDominantLanguageDetectionJob
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
- Parameters:
describeDominantLanguageDetectionJobRequest-- Returns:
- Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDominantLanguageDetectionJob
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeDominantLanguageDetectionJobRequest.builder()- Parameters:
describeDominantLanguageDetectionJobRequest- AConsumerthat will call methods onDescribeDominantLanguageDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeEndpointRequest.builder()- Parameters:
describeEndpointRequest- AConsumerthat will call methods onDescribeEndpointRequest.Builderto create a request.- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntitiesDetectionJob
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
- Parameters:
describeEntitiesDetectionJobRequest-- Returns:
- Result of the DescribeEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntitiesDetectionJob
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeEntitiesDetectionJobRequest.builder()- Parameters:
describeEntitiesDetectionJobRequest- AConsumerthat will call methods onDescribeEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntityRecognizer
default DescribeEntityRecognizerResponse describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
- Parameters:
describeEntityRecognizerRequest-- Returns:
- Result of the DescribeEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntityRecognizer
default DescribeEntityRecognizerResponse describeEntityRecognizer(Consumer<DescribeEntityRecognizerRequest.Builder> describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeEntityRecognizerRequest.builder()- Parameters:
describeEntityRecognizerRequest- AConsumerthat will call methods onDescribeEntityRecognizerRequest.Builderto create a request.- Returns:
- Result of the DescribeEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventsDetectionJob
default DescribeEventsDetectionJobResponse describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the status and details of an events detection job.
- Parameters:
describeEventsDetectionJobRequest-- Returns:
- Result of the DescribeEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventsDetectionJob
default DescribeEventsDetectionJobResponse describeEventsDetectionJob(Consumer<DescribeEventsDetectionJobRequest.Builder> describeEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the status and details of an events detection job.
This is a convenience which creates an instance of the
DescribeEventsDetectionJobRequest.Builderavoiding the need to create one manually viaDescribeEventsDetectionJobRequest.builder()- Parameters:
describeEventsDetectionJobRequest- AConsumerthat will call methods onDescribeEventsDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFlywheel
default DescribeFlywheelResponse describeFlywheel(DescribeFlywheelRequest describeFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
- Parameters:
describeFlywheelRequest-- Returns:
- Result of the DescribeFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFlywheel
default DescribeFlywheelResponse describeFlywheel(Consumer<DescribeFlywheelRequest.Builder> describeFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeFlywheelRequest.builder()- Parameters:
describeFlywheelRequest- AConsumerthat will call methods onDescribeFlywheelRequest.Builderto create a request.- Returns:
- Result of the DescribeFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFlywheelIteration
default DescribeFlywheelIterationResponse describeFlywheelIteration(DescribeFlywheelIterationRequest describeFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DescribeFlywheelIteration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFlywheelIteration
default DescribeFlywheelIterationResponse describeFlywheelIteration(Consumer<DescribeFlywheelIterationRequest.Builder> describeFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeFlywheelIterationRequest.builder()- Parameters:
describeFlywheelIterationRequest- AConsumerthat will call methods onDescribeFlywheelIterationRequest.Builderto create a request.- Returns:
- Result of the DescribeFlywheelIteration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKeyPhrasesDetectionJob
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
- Parameters:
describeKeyPhrasesDetectionJobRequest-- Returns:
- Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKeyPhrasesDetectionJob
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeKeyPhrasesDetectionJobRequest.builder()- Parameters:
describeKeyPhrasesDetectionJobRequest- AConsumerthat will call methods onDescribeKeyPhrasesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePiiEntitiesDetectionJob
default DescribePiiEntitiesDetectionJobResponse describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePiiEntitiesDetectionJob
default DescribePiiEntitiesDetectionJobResponse describePiiEntitiesDetectionJob(Consumer<DescribePiiEntitiesDetectionJobRequest.Builder> describePiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribePiiEntitiesDetectionJobRequest.builder()- Parameters:
describePiiEntitiesDetectionJobRequest- AConsumerthat will call methods onDescribePiiEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeResourcePolicy
default DescribeResourcePolicyResponse describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DescribeResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeResourcePolicy
default DescribeResourcePolicyResponse describeResourcePolicy(Consumer<DescribeResourcePolicyRequest.Builder> describeResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeResourcePolicyRequest.builder()- Parameters:
describeResourcePolicyRequest- AConsumerthat will call methods onDescribeResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the DescribeResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSentimentDetectionJob
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
- Parameters:
describeSentimentDetectionJobRequest-- Returns:
- Result of the DescribeSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSentimentDetectionJob
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeSentimentDetectionJobRequest.builder()- Parameters:
describeSentimentDetectionJobRequest- AConsumerthat will call methods onDescribeSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTargetedSentimentDetectionJob
default DescribeTargetedSentimentDetectionJobResponse describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
- Parameters:
describeTargetedSentimentDetectionJobRequest-- Returns:
- Result of the DescribeTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTargetedSentimentDetectionJob
default DescribeTargetedSentimentDetectionJobResponse describeTargetedSentimentDetectionJob(Consumer<DescribeTargetedSentimentDetectionJobRequest.Builder> describeTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeTargetedSentimentDetectionJobRequest.builder()- Parameters:
describeTargetedSentimentDetectionJobRequest- AConsumerthat will call methods onDescribeTargetedSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicsDetectionJob
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
- Parameters:
describeTopicsDetectionJobRequest-- Returns:
- Result of the DescribeTopicsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicsDetectionJob
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDescribeTopicsDetectionJobRequest.builder()- Parameters:
describeTopicsDetectionJobRequest- AConsumerthat will call methods onDescribeTopicsDetectionJobRequest.Builderto create a request.- Returns:
- Result of the DescribeTopicsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectDominantLanguage
default DetectDominantLanguageResponse detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DetectDominantLanguage operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectDominantLanguage
default DetectDominantLanguageResponse detectDominantLanguage(Consumer<DetectDominantLanguageRequest.Builder> detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDetectDominantLanguageRequest.builder()- Parameters:
detectDominantLanguageRequest- AConsumerthat will call methods onDetectDominantLanguageRequest.Builderto create a request.- Returns:
- Result of the DetectDominantLanguage operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectEntities
default DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
Errorsfor each error.If the system detects a document-level error in your input document, the API returns an
InvalidRequestExceptionerror response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.- Parameters:
detectEntitiesRequest-- Returns:
- Result of the DetectEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectEntities
default DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
Errorsfor each error.If the system detects a document-level error in your input document, the API returns an
InvalidRequestExceptionerror 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.Builderavoiding the need to create one manually viaDetectEntitiesRequest.builder()- Parameters:
detectEntitiesRequest- AConsumerthat will call methods onDetectEntitiesRequest.Builderto create a request.- Returns:
- Result of the DetectEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectKeyPhrases
default DetectKeyPhrasesResponse detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in the text.
- Parameters:
detectKeyPhrasesRequest-- Returns:
- Result of the DetectKeyPhrases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectKeyPhrases
default DetectKeyPhrasesResponse detectKeyPhrases(Consumer<DetectKeyPhrasesRequest.Builder> detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in the text.
This is a convenience which creates an instance of the
DetectKeyPhrasesRequest.Builderavoiding the need to create one manually viaDetectKeyPhrasesRequest.builder()- Parameters:
detectKeyPhrasesRequest- AConsumerthat will call methods onDetectKeyPhrasesRequest.Builderto create a request.- Returns:
- Result of the DetectKeyPhrases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectPiiEntities
default DetectPiiEntitiesResponse detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
- Parameters:
detectPiiEntitiesRequest-- Returns:
- Result of the DetectPiiEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectPiiEntities
default DetectPiiEntitiesResponse detectPiiEntities(Consumer<DetectPiiEntitiesRequest.Builder> detectPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDetectPiiEntitiesRequest.builder()- Parameters:
detectPiiEntitiesRequest- AConsumerthat will call methods onDetectPiiEntitiesRequest.Builderto create a request.- Returns:
- Result of the DetectPiiEntities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectSentiment
default DetectSentimentResponse detectSentiment(DetectSentimentRequest detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE,NEUTRAL,MIXED, orNEGATIVE).- Parameters:
detectSentimentRequest-- Returns:
- Result of the DetectSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectSentiment
default DetectSentimentResponse detectSentiment(Consumer<DetectSentimentRequest.Builder> detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE,NEUTRAL,MIXED, orNEGATIVE).
This is a convenience which creates an instance of the
DetectSentimentRequest.Builderavoiding the need to create one manually viaDetectSentimentRequest.builder()- Parameters:
detectSentimentRequest- AConsumerthat will call methods onDetectSentimentRequest.Builderto create a request.- Returns:
- Result of the DetectSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectSyntax
default DetectSyntaxResponse detectSyntax(DetectSyntaxRequest detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DetectSyntax operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectSyntax
default DetectSyntaxResponse detectSyntax(Consumer<DetectSyntaxRequest.Builder> detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDetectSyntaxRequest.builder()- Parameters:
detectSyntaxRequest- AConsumerthat will call methods onDetectSyntaxRequest.Builderto create a request.- Returns:
- Result of the DetectSyntax operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectTargetedSentiment
default DetectTargetedSentimentResponse detectTargetedSentiment(DetectTargetedSentimentRequest detectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DetectTargetedSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectTargetedSentiment
default DetectTargetedSentimentResponse detectTargetedSentiment(Consumer<DetectTargetedSentimentRequest.Builder> detectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDetectTargetedSentimentRequest.builder()- Parameters:
detectTargetedSentimentRequest- AConsumerthat will call methods onDetectTargetedSentimentRequest.Builderto create a request.- Returns:
- Result of the DetectTargetedSentiment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectToxicContent
default DetectToxicContentResponse detectToxicContent(DetectToxicContentRequest detectToxicContentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the DetectToxicContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
detectToxicContent
default DetectToxicContentResponse detectToxicContent(Consumer<DetectToxicContentRequest.Builder> detectToxicContentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaDetectToxicContentRequest.builder()- Parameters:
detectToxicContentRequest- AConsumerthat will call methods onDetectToxicContentRequest.Builderto create a request.- Returns:
- Result of the DetectToxicContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importModel
default ImportModelResponse importModel(ImportModelRequest importModelRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ResourceUnavailableException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ImportModel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importModel
default ImportModelResponse importModel(Consumer<ImportModelRequest.Builder> importModelRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ResourceUnavailableException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaImportModelRequest.builder()- Parameters:
importModelRequest- AConsumerthat will call methods onImportModelRequest.Builderto create a request.- Returns:
- Result of the ImportModel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatasets
default ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ListDatasets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatasets
default ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaListDatasetsRequest.builder()- Parameters:
listDatasetsRequest- AConsumerthat will call methods onListDatasetsRequest.Builderto create a request.- Returns:
- Result of the ListDatasets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)operation.- Parameters:
listDatasetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)operation.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builderavoiding the need to create one manually viaListDatasetsRequest.builder()- Parameters:
listDatasetsRequest- AConsumerthat will call methods onListDatasetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
- Parameters:
listDocumentClassificationJobsRequest-- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
This is a convenience which creates an instance of the
ListDocumentClassificationJobsRequest.Builderavoiding the need to create one manually viaListDocumentClassificationJobsRequest.builder()- Parameters:
listDocumentClassificationJobsRequest- AConsumerthat will call methods onListDocumentClassificationJobsRequest.Builderto create a request.- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest), AWS API Documentation
-
listDocumentClassificationJobsPaginator
default ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client .listDocumentClassificationJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listDocumentClassificationJobsPaginator(ListDocumentClassificationJobsRequest), AWS API Documentation
-
listDocumentClassificationJobsPaginator
default ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client .listDocumentClassificationJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation.- Parameters:
listDocumentClassificationJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassificationJobsPaginator
default ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client .listDocumentClassificationJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)operation.
This is a convenience which creates an instance of the
ListDocumentClassificationJobsRequest.Builderavoiding the need to create one manually viaListDocumentClassificationJobsRequest.builder()- Parameters:
listDocumentClassificationJobsRequest- AConsumerthat will call methods onListDocumentClassificationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifierSummaries
default ListDocumentClassifierSummariesResponse listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
- Parameters:
listDocumentClassifierSummariesRequest-- Returns:
- Result of the ListDocumentClassifierSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifierSummaries
default ListDocumentClassifierSummariesResponse listDocumentClassifierSummaries(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
This is a convenience which creates an instance of the
ListDocumentClassifierSummariesRequest.Builderavoiding the need to create one manually viaListDocumentClassifierSummariesRequest.builder()- Parameters:
listDocumentClassifierSummariesRequest- AConsumerthat will call methods onListDocumentClassifierSummariesRequest.Builderto create a request.- Returns:
- Result of the ListDocumentClassifierSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifierSummariesPaginator
default ListDocumentClassifierSummariesIterable listDocumentClassifierSummariesPaginator(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client .listDocumentClassifierSummariesPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)operation.- Parameters:
listDocumentClassifierSummariesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifierSummariesPaginator
default ListDocumentClassifierSummariesIterable listDocumentClassifierSummariesPaginator(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client .listDocumentClassifierSummariesPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)operation.
This is a convenience which creates an instance of the
ListDocumentClassifierSummariesRequest.Builderavoiding the need to create one manually viaListDocumentClassifierSummariesRequest.builder()- Parameters:
listDocumentClassifierSummariesRequest- AConsumerthat will call methods onListDocumentClassifierSummariesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
- Parameters:
listDocumentClassifiersRequest-- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
This is a convenience which creates an instance of the
ListDocumentClassifiersRequest.Builderavoiding the need to create one manually viaListDocumentClassifiersRequest.builder()- Parameters:
listDocumentClassifiersRequest- AConsumerthat will call methods onListDocumentClassifiersRequest.Builderto create a request.- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDocumentClassifiers(ListDocumentClassifiersRequest), AWS API Documentation
-
listDocumentClassifiersPaginator
default ListDocumentClassifiersIterable listDocumentClassifiersPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client .listDocumentClassifiersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listDocumentClassifiersPaginator(ListDocumentClassifiersRequest), AWS API Documentation
-
listDocumentClassifiersPaginator
default ListDocumentClassifiersIterable listDocumentClassifiersPaginator(ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client .listDocumentClassifiersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation.- Parameters:
listDocumentClassifiersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentClassifiersPaginator
default ListDocumentClassifiersIterable listDocumentClassifiersPaginator(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client .listDocumentClassifiersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)operation.
This is a convenience which creates an instance of the
ListDocumentClassifiersRequest.Builderavoiding the need to create one manually viaListDocumentClassifiersRequest.builder()- Parameters:
listDocumentClassifiersRequest- AConsumerthat will call methods onListDocumentClassifiersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDominantLanguageDetectionJobs
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
- Parameters:
listDominantLanguageDetectionJobsRequest-- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDominantLanguageDetectionJobs
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListDominantLanguageDetectionJobsRequest.Builderavoiding the need to create one manually viaListDominantLanguageDetectionJobsRequest.builder()- Parameters:
listDominantLanguageDetectionJobsRequest- AConsumerthat will call methods onListDominantLanguageDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDominantLanguageDetectionJobs
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest), AWS API Documentation
-
listDominantLanguageDetectionJobsPaginator
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest), AWS API Documentation
-
listDominantLanguageDetectionJobsPaginator
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation.- Parameters:
listDominantLanguageDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDominantLanguageDetectionJobsPaginator
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListDominantLanguageDetectionJobsRequest.Builderavoiding the need to create one manually viaListDominantLanguageDetectionJobsRequest.builder()- Parameters:
listDominantLanguageDetectionJobsRequest- AConsumerthat will call methods onListDominantLanguageDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEndpoints
default ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
- Parameters:
listEndpointsRequest-- Returns:
- Result of the ListEndpoints operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEndpoints
default ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaListEndpointsRequest.builder()- Parameters:
listEndpointsRequest- AConsumerthat will call methods onListEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListEndpoints operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client .listEndpointsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest)operation.- Parameters:
listEndpointsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client .listEndpointsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest)operation.
This is a convenience which creates an instance of the
ListEndpointsRequest.Builderavoiding the need to create one manually viaListEndpointsRequest.builder()- Parameters:
listEndpointsRequest- AConsumerthat will call methods onListEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
- Parameters:
listEntitiesDetectionJobsRequest-- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListEntitiesDetectionJobsRequest.Builderavoiding the need to create one manually viaListEntitiesDetectionJobsRequest.builder()- Parameters:
listEntitiesDetectionJobsRequest- AConsumerthat will call methods onListEntitiesDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest), AWS API Documentation
-
listEntitiesDetectionJobsPaginator
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest), AWS API Documentation
-
listEntitiesDetectionJobsPaginator
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation.- Parameters:
listEntitiesDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntitiesDetectionJobsPaginator
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListEntitiesDetectionJobsRequest.Builderavoiding the need to create one manually viaListEntitiesDetectionJobsRequest.builder()- Parameters:
listEntitiesDetectionJobsRequest- AConsumerthat will call methods onListEntitiesDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizerSummaries
default ListEntityRecognizerSummariesResponse listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
- Parameters:
listEntityRecognizerSummariesRequest-- Returns:
- Result of the ListEntityRecognizerSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizerSummaries
default ListEntityRecognizerSummariesResponse listEntityRecognizerSummaries(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
This is a convenience which creates an instance of the
ListEntityRecognizerSummariesRequest.Builderavoiding the need to create one manually viaListEntityRecognizerSummariesRequest.builder()- Parameters:
listEntityRecognizerSummariesRequest- AConsumerthat will call methods onListEntityRecognizerSummariesRequest.Builderto create a request.- Returns:
- Result of the ListEntityRecognizerSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizerSummariesPaginator
default ListEntityRecognizerSummariesIterable listEntityRecognizerSummariesPaginator(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client .listEntityRecognizerSummariesPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)operation.- Parameters:
listEntityRecognizerSummariesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizerSummariesPaginator
default ListEntityRecognizerSummariesIterable listEntityRecognizerSummariesPaginator(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client .listEntityRecognizerSummariesPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)operation.
This is a convenience which creates an instance of the
ListEntityRecognizerSummariesRequest.Builderavoiding the need to create one manually viaListEntityRecognizerSummariesRequest.builder()- Parameters:
listEntityRecognizerSummariesRequest- AConsumerthat will call methods onListEntityRecognizerSummariesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizers
default ListEntityRecognizersResponse listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ListEntityRecognizers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizers
default ListEntityRecognizersResponse listEntityRecognizers(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaListEntityRecognizersRequest.builder()- Parameters:
listEntityRecognizersRequest- AConsumerthat will call methods onListEntityRecognizersRequest.Builderto create a request.- Returns:
- Result of the ListEntityRecognizers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizers
default ListEntityRecognizersResponse listEntityRecognizers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ListEntityRecognizers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listEntityRecognizers(ListEntityRecognizersRequest), AWS API Documentation
-
listEntityRecognizersPaginator
default ListEntityRecognizersIterable listEntityRecognizersPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client .listEntityRecognizersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listEntityRecognizersPaginator(ListEntityRecognizersRequest), AWS API Documentation
-
listEntityRecognizersPaginator
default ListEntityRecognizersIterable listEntityRecognizersPaginator(ListEntityRecognizersRequest listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client .listEntityRecognizersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation.- Parameters:
listEntityRecognizersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEntityRecognizersPaginator
default ListEntityRecognizersIterable listEntityRecognizersPaginator(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client .listEntityRecognizersPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)operation.
This is a convenience which creates an instance of the
ListEntityRecognizersRequest.Builderavoiding the need to create one manually viaListEntityRecognizersRequest.builder()- Parameters:
listEntityRecognizersRequest- AConsumerthat will call methods onListEntityRecognizersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventsDetectionJobs
default ListEventsDetectionJobsResponse listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
- Parameters:
listEventsDetectionJobsRequest-- Returns:
- Result of the ListEventsDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventsDetectionJobs
default ListEventsDetectionJobsResponse listEventsDetectionJobs(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListEventsDetectionJobsRequest.Builderavoiding the need to create one manually viaListEventsDetectionJobsRequest.builder()- Parameters:
listEventsDetectionJobsRequest- AConsumerthat will call methods onListEventsDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListEventsDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventsDetectionJobsPaginator
default ListEventsDetectionJobsIterable listEventsDetectionJobsPaginator(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client .listEventsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)operation.- Parameters:
listEventsDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventsDetectionJobsPaginator
default ListEventsDetectionJobsIterable listEventsDetectionJobsPaginator(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client .listEventsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListEventsDetectionJobsRequest.Builderavoiding the need to create one manually viaListEventsDetectionJobsRequest.builder()- Parameters:
listEventsDetectionJobsRequest- AConsumerthat will call methods onListEventsDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelIterationHistory
default ListFlywheelIterationHistoryResponse listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the ListFlywheelIterationHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelIterationHistory
default ListFlywheelIterationHistoryResponse listFlywheelIterationHistory(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaListFlywheelIterationHistoryRequest.builder()- Parameters:
listFlywheelIterationHistoryRequest- AConsumerthat will call methods onListFlywheelIterationHistoryRequest.Builderto create a request.- Returns:
- Result of the ListFlywheelIterationHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelIterationHistoryPaginator
default ListFlywheelIterationHistoryIterable listFlywheelIterationHistoryPaginator(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client .listFlywheelIterationHistoryPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)operation.- Parameters:
listFlywheelIterationHistoryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelIterationHistoryPaginator
default ListFlywheelIterationHistoryIterable listFlywheelIterationHistoryPaginator(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client .listFlywheelIterationHistoryPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)operation.
This is a convenience which creates an instance of the
ListFlywheelIterationHistoryRequest.Builderavoiding the need to create one manually viaListFlywheelIterationHistoryRequest.builder()- Parameters:
listFlywheelIterationHistoryRequest- AConsumerthat will call methods onListFlywheelIterationHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheels
default ListFlywheelsResponse listFlywheels(ListFlywheelsRequest listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
- Parameters:
listFlywheelsRequest-- Returns:
- Result of the ListFlywheels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheels
default ListFlywheelsResponse listFlywheels(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
This is a convenience which creates an instance of the
ListFlywheelsRequest.Builderavoiding the need to create one manually viaListFlywheelsRequest.builder()- Parameters:
listFlywheelsRequest- AConsumerthat will call methods onListFlywheelsRequest.Builderto create a request.- Returns:
- Result of the ListFlywheels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelsPaginator
default ListFlywheelsIterable listFlywheelsPaginator(ListFlywheelsRequest listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client .listFlywheelsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest)operation.- Parameters:
listFlywheelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlywheelsPaginator
default ListFlywheelsIterable listFlywheelsPaginator(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client .listFlywheelsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest)operation.
This is a convenience which creates an instance of the
ListFlywheelsRequest.Builderavoiding the need to create one manually viaListFlywheelsRequest.builder()- Parameters:
listFlywheelsRequest- AConsumerthat will call methods onListFlywheelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
- Parameters:
listKeyPhrasesDetectionJobsRequest-- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListKeyPhrasesDetectionJobsRequest.Builderavoiding the need to create one manually viaListKeyPhrasesDetectionJobsRequest.builder()- Parameters:
listKeyPhrasesDetectionJobsRequest- AConsumerthat will call methods onListKeyPhrasesDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest), AWS API Documentation
-
listKeyPhrasesDetectionJobsPaginator
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest), AWS API Documentation
-
listKeyPhrasesDetectionJobsPaginator
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation.- Parameters:
listKeyPhrasesDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeyPhrasesDetectionJobsPaginator
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListKeyPhrasesDetectionJobsRequest.Builderavoiding the need to create one manually viaListKeyPhrasesDetectionJobsRequest.builder()- Parameters:
listKeyPhrasesDetectionJobsRequest- AConsumerthat will call methods onListKeyPhrasesDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPiiEntitiesDetectionJobs
default ListPiiEntitiesDetectionJobsResponse listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
- Parameters:
listPiiEntitiesDetectionJobsRequest-- Returns:
- Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPiiEntitiesDetectionJobs
default ListPiiEntitiesDetectionJobsResponse listPiiEntitiesDetectionJobs(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListPiiEntitiesDetectionJobsRequest.Builderavoiding the need to create one manually viaListPiiEntitiesDetectionJobsRequest.builder()- Parameters:
listPiiEntitiesDetectionJobsRequest- AConsumerthat will call methods onListPiiEntitiesDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPiiEntitiesDetectionJobsPaginator
default ListPiiEntitiesDetectionJobsIterable listPiiEntitiesDetectionJobsPaginator(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client .listPiiEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)operation.- Parameters:
listPiiEntitiesDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPiiEntitiesDetectionJobsPaginator
default ListPiiEntitiesDetectionJobsIterable listPiiEntitiesDetectionJobsPaginator(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client .listPiiEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListPiiEntitiesDetectionJobsRequest.Builderavoiding the need to create one manually viaListPiiEntitiesDetectionJobsRequest.builder()- Parameters:
listPiiEntitiesDetectionJobsRequest- AConsumerthat will call methods onListPiiEntitiesDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
- Parameters:
listSentimentDetectionJobsRequest-- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListSentimentDetectionJobsRequest.Builderavoiding the need to create one manually viaListSentimentDetectionJobsRequest.builder()- Parameters:
listSentimentDetectionJobsRequest- AConsumerthat will call methods onListSentimentDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest), AWS API Documentation
-
listSentimentDetectionJobsPaginator
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest), AWS API Documentation
-
listSentimentDetectionJobsPaginator
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation.- Parameters:
listSentimentDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSentimentDetectionJobsPaginator
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListSentimentDetectionJobsRequest.Builderavoiding the need to create one manually viaListSentimentDetectionJobsRequest.builder()- Parameters:
listSentimentDetectionJobsRequest- AConsumerthat will call methods onListSentimentDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Lists all tags associated with a given Amazon Comprehend resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Lists all tags associated with a given Amazon Comprehend resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTargetedSentimentDetectionJobs
default ListTargetedSentimentDetectionJobsResponse listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
- Parameters:
listTargetedSentimentDetectionJobsRequest-- Returns:
- Result of the ListTargetedSentimentDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTargetedSentimentDetectionJobs
default ListTargetedSentimentDetectionJobsResponse listTargetedSentimentDetectionJobs(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListTargetedSentimentDetectionJobsRequest.Builderavoiding the need to create one manually viaListTargetedSentimentDetectionJobsRequest.builder()- Parameters:
listTargetedSentimentDetectionJobsRequest- AConsumerthat will call methods onListTargetedSentimentDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListTargetedSentimentDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTargetedSentimentDetectionJobsPaginator
default ListTargetedSentimentDetectionJobsIterable listTargetedSentimentDetectionJobsPaginator(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client .listTargetedSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)operation.- Parameters:
listTargetedSentimentDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTargetedSentimentDetectionJobsPaginator
default ListTargetedSentimentDetectionJobsIterable listTargetedSentimentDetectionJobsPaginator(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client .listTargetedSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListTargetedSentimentDetectionJobsRequest.Builderavoiding the need to create one manually viaListTargetedSentimentDetectionJobsRequest.builder()- Parameters:
listTargetedSentimentDetectionJobsRequest- AConsumerthat will call methods onListTargetedSentimentDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
- Parameters:
listTopicsDetectionJobsRequest-- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListTopicsDetectionJobsRequest.Builderavoiding the need to create one manually viaListTopicsDetectionJobsRequest.builder()- Parameters:
listTopicsDetectionJobsRequest- AConsumerthat will call methods onListTopicsDetectionJobsRequest.Builderto create a request.- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest), AWS API Documentation
-
listTopicsDetectionJobsPaginator
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest), AWS API Documentation
-
listTopicsDetectionJobsPaginator
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation.- Parameters:
listTopicsDetectionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsDetectionJobsPaginator
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)operation.
This is a convenience which creates an instance of the
ListTopicsDetectionJobsRequest.Builderavoiding the need to create one manually viaListTopicsDetectionJobsRequest.builder()- Parameters:
listTopicsDetectionJobsRequest- AConsumerthat will call methods onListTopicsDetectionJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaPutResourcePolicyRequest.builder()- Parameters:
putResourcePolicyRequest- AConsumerthat will call methods onPutResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startDocumentClassificationJob
default StartDocumentClassificationJobResponse startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job using a custom classification model. Use the
DescribeDocumentClassificationJoboperation to track the progress of the job.- Parameters:
startDocumentClassificationJobRequest-- Returns:
- Result of the StartDocumentClassificationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startDocumentClassificationJob
default StartDocumentClassificationJobResponse startDocumentClassificationJob(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job using a custom classification model. Use the
DescribeDocumentClassificationJoboperation to track the progress of the job.
This is a convenience which creates an instance of the
StartDocumentClassificationJobRequest.Builderavoiding the need to create one manually viaStartDocumentClassificationJobRequest.builder()- Parameters:
startDocumentClassificationJobRequest- AConsumerthat will call methods onStartDocumentClassificationJobRequest.Builderto create a request.- Returns:
- Result of the StartDocumentClassificationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startDominantLanguageDetectionJob
default StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the StartDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startDominantLanguageDetectionJob
default StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaStartDominantLanguageDetectionJobRequest.builder()- Parameters:
startDominantLanguageDetectionJobRequest- AConsumerthat will call methods onStartDominantLanguageDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startEntitiesDetectionJob
default StartEntitiesDetectionJobResponse startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
EntityRecognizerArnmust be used in order to provide access to the recognizer being used to detect the custom entity.- Parameters:
startEntitiesDetectionJobRequest-- Returns:
- Result of the StartEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startEntitiesDetectionJob
default StartEntitiesDetectionJobResponse startEntitiesDetectionJob(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
EntityRecognizerArnmust 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.Builderavoiding the need to create one manually viaStartEntitiesDetectionJobRequest.builder()- Parameters:
startEntitiesDetectionJobRequest- AConsumerthat will call methods onStartEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startEventsDetectionJob
default StartEventsDetectionJobResponse startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous event detection job for a collection of documents.
- Parameters:
startEventsDetectionJobRequest-- Returns:
- Result of the StartEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startEventsDetectionJob
default StartEventsDetectionJobResponse startEventsDetectionJob(Consumer<StartEventsDetectionJobRequest.Builder> startEventsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous event detection job for a collection of documents.
This is a convenience which creates an instance of the
StartEventsDetectionJobRequest.Builderavoiding the need to create one manually viaStartEventsDetectionJobRequest.builder()- Parameters:
startEventsDetectionJobRequest- AConsumerthat will call methods onStartEventsDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startFlywheelIteration
default StartFlywheelIterationResponse startFlywheelIteration(StartFlywheelIterationRequest startFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the StartFlywheelIteration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startFlywheelIteration
default StartFlywheelIterationResponse startFlywheelIteration(Consumer<StartFlywheelIterationRequest.Builder> startFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaStartFlywheelIterationRequest.builder()- Parameters:
startFlywheelIterationRequest- AConsumerthat will call methods onStartFlywheelIterationRequest.Builderto create a request.- Returns:
- Result of the StartFlywheelIteration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startKeyPhrasesDetectionJob
default StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the StartKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startKeyPhrasesDetectionJob
default StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaStartKeyPhrasesDetectionJobRequest.builder()- Parameters:
startKeyPhrasesDetectionJobRequest- AConsumerthat will call methods onStartKeyPhrasesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startPiiEntitiesDetectionJob
default StartPiiEntitiesDetectionJobResponse startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous PII entity detection job for a collection of documents.
- Parameters:
startPiiEntitiesDetectionJobRequest-- Returns:
- Result of the StartPiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startPiiEntitiesDetectionJob
default StartPiiEntitiesDetectionJobResponse startPiiEntitiesDetectionJob(Consumer<StartPiiEntitiesDetectionJobRequest.Builder> startPiiEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous PII entity detection job for a collection of documents.
This is a convenience which creates an instance of the
StartPiiEntitiesDetectionJobRequest.Builderavoiding the need to create one manually viaStartPiiEntitiesDetectionJobRequest.builder()- Parameters:
startPiiEntitiesDetectionJobRequest- AConsumerthat will call methods onStartPiiEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartPiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSentimentDetectionJob
default StartSentimentDetectionJobResponse startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
- Parameters:
startSentimentDetectionJobRequest-- Returns:
- Result of the StartSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSentimentDetectionJob
default StartSentimentDetectionJobResponse startSentimentDetectionJob(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaStartSentimentDetectionJobRequest.builder()- Parameters:
startSentimentDetectionJobRequest- AConsumerthat will call methods onStartSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startTargetedSentimentDetectionJob
default StartTargetedSentimentDetectionJobResponse startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJoboperation to track the status of a job.- Parameters:
startTargetedSentimentDetectionJobRequest-- Returns:
- Result of the StartTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startTargetedSentimentDetectionJob
default StartTargetedSentimentDetectionJobResponse startTargetedSentimentDetectionJob(Consumer<StartTargetedSentimentDetectionJobRequest.Builder> startTargetedSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJoboperation to track the status of a job.
This is a convenience which creates an instance of the
StartTargetedSentimentDetectionJobRequest.Builderavoiding the need to create one manually viaStartTargetedSentimentDetectionJobRequest.builder()- Parameters:
startTargetedSentimentDetectionJobRequest- AConsumerthat will call methods onStartTargetedSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startTopicsDetectionJob
default StartTopicsDetectionJobResponse startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous topic detection job. Use the
DescribeTopicDetectionJoboperation to track the status of a job.- Parameters:
startTopicsDetectionJobRequest-- Returns:
- Result of the StartTopicsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startTopicsDetectionJob
default StartTopicsDetectionJobResponse startTopicsDetectionJob(Consumer<StartTopicsDetectionJobRequest.Builder> startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous topic detection job. Use the
DescribeTopicDetectionJoboperation to track the status of a job.
This is a convenience which creates an instance of the
StartTopicsDetectionJobRequest.Builderavoiding the need to create one manually viaStartTopicsDetectionJobRequest.builder()- Parameters:
startTopicsDetectionJobRequest- AConsumerthat will call methods onStartTopicsDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StartTopicsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopDominantLanguageDetectionJob
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a dominant language detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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:
- Result of the StopDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopDominantLanguageDetectionJob
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a dominant language detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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.Builderavoiding the need to create one manually viaStopDominantLanguageDetectionJobRequest.builder()- Parameters:
stopDominantLanguageDetectionJobRequest- AConsumerthat will call methods onStopDominantLanguageDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopDominantLanguageDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopEntitiesDetectionJob
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an entities detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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:
- Result of the StopEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopEntitiesDetectionJob
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(Consumer<StopEntitiesDetectionJobRequest.Builder> stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an entities detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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.Builderavoiding the need to create one manually viaStopEntitiesDetectionJobRequest.builder()- Parameters:
stopEntitiesDetectionJobRequest- AConsumerthat will call methods onStopEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopEventsDetectionJob
default StopEventsDetectionJobResponse stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an events detection job in progress.
- Parameters:
stopEventsDetectionJobRequest-- Returns:
- Result of the StopEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopEventsDetectionJob
default StopEventsDetectionJobResponse stopEventsDetectionJob(Consumer<StopEventsDetectionJobRequest.Builder> stopEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an events detection job in progress.
This is a convenience which creates an instance of the
StopEventsDetectionJobRequest.Builderavoiding the need to create one manually viaStopEventsDetectionJobRequest.builder()- Parameters:
stopEventsDetectionJobRequest- AConsumerthat will call methods onStopEventsDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopEventsDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopKeyPhrasesDetectionJob
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a key phrases detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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:
- Result of the StopKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopKeyPhrasesDetectionJob
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a key phrases detection job in progress.
If the job state is
IN_PROGRESSthe job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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.Builderavoiding the need to create one manually viaStopKeyPhrasesDetectionJobRequest.builder()- Parameters:
stopKeyPhrasesDetectionJobRequest- AConsumerthat will call methods onStopKeyPhrasesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopKeyPhrasesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopPiiEntitiesDetectionJob
default StopPiiEntitiesDetectionJobResponse stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a PII entities detection job in progress.
- Parameters:
stopPiiEntitiesDetectionJobRequest-- Returns:
- Result of the StopPiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopPiiEntitiesDetectionJob
default StopPiiEntitiesDetectionJobResponse stopPiiEntitiesDetectionJob(Consumer<StopPiiEntitiesDetectionJobRequest.Builder> stopPiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a PII entities detection job in progress.
This is a convenience which creates an instance of the
StopPiiEntitiesDetectionJobRequest.Builderavoiding the need to create one manually viaStopPiiEntitiesDetectionJobRequest.builder()- Parameters:
stopPiiEntitiesDetectionJobRequest- AConsumerthat will call methods onStopPiiEntitiesDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopPiiEntitiesDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopSentimentDetectionJob
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a sentiment detection job in progress.
If the job state is
IN_PROGRESS, the job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is be stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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:
- Result of the StopSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopSentimentDetectionJob
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a sentiment detection job in progress.
If the job state is
IN_PROGRESS, the job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is be stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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.Builderavoiding the need to create one manually viaStopSentimentDetectionJobRequest.builder()- Parameters:
stopSentimentDetectionJobRequest- AConsumerthat will call methods onStopSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTargetedSentimentDetectionJob
default StopTargetedSentimentDetectionJobResponse stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a targeted sentiment detection job in progress.
If the job state is
IN_PROGRESS, the job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is be stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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:
- Result of the StopTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTargetedSentimentDetectionJob
default StopTargetedSentimentDetectionJobResponse stopTargetedSentimentDetectionJob(Consumer<StopTargetedSentimentDetectionJobRequest.Builder> stopTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a targeted sentiment detection job in progress.
If the job state is
IN_PROGRESS, the job is marked for termination and put into theSTOP_REQUESTEDstate. If the job completes before it can be stopped, it is put into theCOMPLETEDstate; otherwise the job is be stopped and put into theSTOPPEDstate.If the job is in the
COMPLETEDorFAILEDstate when you call theStopDominantLanguageDetectionJoboperation, 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.Builderavoiding the need to create one manually viaStopTargetedSentimentDetectionJobRequest.builder()- Parameters:
stopTargetedSentimentDetectionJobRequest- AConsumerthat will call methods onStopTargetedSentimentDetectionJobRequest.Builderto create a request.- Returns:
- Result of the StopTargetedSentimentDetectionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTrainingDocumentClassifier
default StopTrainingDocumentClassifierResponse stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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 theSTOP_REQUESTEDstate. If the training job completes before it can be stopped, it is put into theTRAINED; otherwise the training job is stopped and put into theSTOPPEDstate and the service sends back an HTTP 200 response with an empty HTTP body.- Parameters:
stopTrainingDocumentClassifierRequest-- Returns:
- Result of the StopTrainingDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTrainingDocumentClassifier
default StopTrainingDocumentClassifierResponse stopTrainingDocumentClassifier(Consumer<StopTrainingDocumentClassifierRequest.Builder> stopTrainingDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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 theSTOP_REQUESTEDstate. If the training job completes before it can be stopped, it is put into theTRAINED; otherwise the training job is stopped and put into theSTOPPEDstate 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.Builderavoiding the need to create one manually viaStopTrainingDocumentClassifierRequest.builder()- Parameters:
stopTrainingDocumentClassifierRequest- AConsumerthat will call methods onStopTrainingDocumentClassifierRequest.Builderto create a request.- Returns:
- Result of the StopTrainingDocumentClassifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTrainingEntityRecognizer
default StopTrainingEntityRecognizerResponse stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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 theSTOP_REQUESTEDstate. If the training job completes before it can be stopped, it is put into theTRAINED; otherwise the training job is stopped and putted into theSTOPPEDstate and the service sends back an HTTP 200 response with an empty HTTP body.- Parameters:
stopTrainingEntityRecognizerRequest-- Returns:
- Result of the StopTrainingEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopTrainingEntityRecognizer
default StopTrainingEntityRecognizerResponse stopTrainingEntityRecognizer(Consumer<StopTrainingEntityRecognizerRequest.Builder> stopTrainingEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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 theSTOP_REQUESTEDstate. If the training job completes before it can be stopped, it is put into theTRAINED; otherwise the training job is stopped and putted into theSTOPPEDstate 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.Builderavoiding the need to create one manually viaStopTrainingEntityRecognizerRequest.builder()- Parameters:
stopTrainingEntityRecognizerRequest- AConsumerthat will call methods onStopTrainingEntityRecognizerRequest.Builderto create a request.- Returns:
- Result of the StopTrainingEntityRecognizer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws TooManyTagKeysException, InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Removes a specific tag associated with an Amazon Comprehend resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws TooManyTagKeysException, InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Removes a specific tag associated with an Amazon Comprehend resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
- Parameters:
updateEndpointRequest-- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the
UpdateEndpointRequest.Builderavoiding the need to create one manually viaUpdateEndpointRequest.builder()- Parameters:
updateEndpointRequest- AConsumerthat will call methods onUpdateEndpointRequest.Builderto create a request.- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlywheel
default UpdateFlywheelResponse updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Update the configuration information for an existing flywheel.
- Parameters:
updateFlywheelRequest-- Returns:
- Result of the UpdateFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlywheel
default UpdateFlywheelResponse updateFlywheel(Consumer<UpdateFlywheelRequest.Builder> updateFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Update the configuration information for an existing flywheel.
This is a convenience which creates an instance of the
UpdateFlywheelRequest.Builderavoiding the need to create one manually viaUpdateFlywheelRequest.builder()- Parameters:
updateFlywheelRequest- AConsumerthat will call methods onUpdateFlywheelRequest.Builderto create a request.- Returns:
- Result of the UpdateFlywheel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ComprehendClient create()
Create aComprehendClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ComprehendClientBuilder builder()
Create a builder that can be used to configure and create aComprehendClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ComprehendServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-