Interface ElementalInferenceAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
This is the AWS Elemental Inference REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental Inference REST operation.
We assume that you have the IAM permissions that you need to use AWS Elemental Inference via the REST API. We also assume that you are familiar with the features and operations of AWS Elemental Inference as described in AWS Elemental Inference User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture<AssociateFeedResponse> associateFeed(Consumer<AssociateFeedRequest.Builder> associateFeedRequest) Associates a resource with the feed.default CompletableFuture<AssociateFeedResponse> associateFeed(AssociateFeedRequest associateFeedRequest) Associates a resource with the feed.builder()Create a builder that can be used to configure and create aElementalInferenceAsyncClient.create()Create aElementalInferenceAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createDictionary(Consumer<CreateDictionaryRequest.Builder> createDictionaryRequest) Creates a custom dictionary for improving transcription accuracy.createDictionary(CreateDictionaryRequest createDictionaryRequest) Creates a custom dictionary for improving transcription accuracy.default CompletableFuture<CreateFeedResponse> createFeed(Consumer<CreateFeedRequest.Builder> createFeedRequest) Creates a feed.default CompletableFuture<CreateFeedResponse> createFeed(CreateFeedRequest createFeedRequest) Creates a feed.deleteDictionary(Consumer<DeleteDictionaryRequest.Builder> deleteDictionaryRequest) Deletes the specified dictionary.deleteDictionary(DeleteDictionaryRequest deleteDictionaryRequest) Deletes the specified dictionary.default CompletableFuture<DeleteFeedResponse> deleteFeed(Consumer<DeleteFeedRequest.Builder> deleteFeedRequest) Deletes the specified feed.default CompletableFuture<DeleteFeedResponse> deleteFeed(DeleteFeedRequest deleteFeedRequest) Deletes the specified feed.disassociateFeed(Consumer<DisassociateFeedRequest.Builder> disassociateFeedRequest) Releases the resource (the source media) that is associated with this feed.disassociateFeed(DisassociateFeedRequest disassociateFeedRequest) Releases the resource (the source media) that is associated with this feed.exportDictionaryEntries(Consumer<ExportDictionaryEntriesRequest.Builder> exportDictionaryEntriesRequest) Exports the entries from the specified dictionary.exportDictionaryEntries(ExportDictionaryEntriesRequest exportDictionaryEntriesRequest) Exports the entries from the specified dictionary.default CompletableFuture<GetDictionaryResponse> getDictionary(Consumer<GetDictionaryRequest.Builder> getDictionaryRequest) Retrieves information about the specified dictionary.default CompletableFuture<GetDictionaryResponse> getDictionary(GetDictionaryRequest getDictionaryRequest) Retrieves information about the specified dictionary.default CompletableFuture<GetFeedResponse> getFeed(Consumer<GetFeedRequest.Builder> getFeedRequest) Retrieves information about the specified feed.default CompletableFuture<GetFeedResponse> getFeed(GetFeedRequest getFeedRequest) Retrieves information about the specified feed.listDictionaries(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) Lists the dictionaries in your account.listDictionaries(ListDictionariesRequest listDictionariesRequest) Lists the dictionaries in your account.default ListDictionariesPublisherlistDictionariesPaginator(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) This is a variant oflistDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation.default ListDictionariesPublisherlistDictionariesPaginator(ListDictionariesRequest listDictionariesRequest) This is a variant oflistDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation.default CompletableFuture<ListFeedsResponse> listFeeds(Consumer<ListFeedsRequest.Builder> listFeedsRequest) Displays a list of feeds that belong to this AWS account.default CompletableFuture<ListFeedsResponse> listFeeds(ListFeedsRequest listFeedsRequest) Displays a list of feeds that belong to this AWS account.default ListFeedsPublisherlistFeedsPaginator(Consumer<ListFeedsRequest.Builder> listFeedsRequest) This is a variant oflistFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation.default ListFeedsPublisherlistFeedsPaginator(ListFeedsRequest listFeedsRequest) This is a variant oflistFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags that are on an Elemental Inference resource in the current region.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags that are on an Elemental Inference resource in the current region.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to the resource identified by the specified resourceArn in the current region.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Associates the specified tags to the resource identified by the specified resourceArn in the current region.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from the specified resource in the current region.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from the specified resource in the current region.updateDictionary(Consumer<UpdateDictionaryRequest.Builder> updateDictionaryRequest) Updates the specified dictionary.updateDictionary(UpdateDictionaryRequest updateDictionaryRequest) Updates the specified dictionary.default CompletableFuture<UpdateFeedResponse> updateFeed(Consumer<UpdateFeedRequest.Builder> updateFeedRequest) Updates the name and/or outputs in a feed.default CompletableFuture<UpdateFeedResponse> updateFeed(UpdateFeedRequest updateFeedRequest) Updates the name and/or outputs in a feed.default ElementalInferenceAsyncWaiterwaiter()Create an instance ofElementalInferenceAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
associateFeed
default CompletableFuture<AssociateFeedResponse> associateFeed(AssociateFeedRequest associateFeedRequest) Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed.
AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation.
Specifically:
-
You can add more outputs to the existing outputs. New outputs will be appended.
-
You can't modify an existing output (for example to change its name). Instead, use UpdateFeed.
-
You can't delete an existing output. Instead, use UpdateFeed.
Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.
- Parameters:
associateFeedRequest-- Returns:
- A Java Future containing the result of the AssociateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
associateFeed
default CompletableFuture<AssociateFeedResponse> associateFeed(Consumer<AssociateFeedRequest.Builder> associateFeedRequest) Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed.
AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation.
Specifically:
-
You can add more outputs to the existing outputs. New outputs will be appended.
-
You can't modify an existing output (for example to change its name). Instead, use UpdateFeed.
-
You can't delete an existing output. Instead, use UpdateFeed.
Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.
This is a convenience which creates an instance of the
AssociateFeedRequest.Builderavoiding the need to create one manually viaAssociateFeedRequest.builder()- Parameters:
associateFeedRequest- AConsumerthat will call methods onAssociateFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createDictionary
default CompletableFuture<CreateDictionaryResponse> createDictionary(CreateDictionaryRequest createDictionaryRequest) Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.
- Parameters:
createDictionaryRequest-- Returns:
- A Java Future containing the result of the CreateDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDictionary
default CompletableFuture<CreateDictionaryResponse> createDictionary(Consumer<CreateDictionaryRequest.Builder> createDictionaryRequest) Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.
This is a convenience which creates an instance of the
CreateDictionaryRequest.Builderavoiding the need to create one manually viaCreateDictionaryRequest.builder()- Parameters:
createDictionaryRequest- AConsumerthat will call methods onCreateDictionaryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFeed
Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive.
The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.
- Parameters:
createFeedRequest-- Returns:
- A Java Future containing the result of the CreateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFeed
default CompletableFuture<CreateFeedResponse> createFeed(Consumer<CreateFeedRequest.Builder> createFeedRequest) Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive.
The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.
This is a convenience which creates an instance of the
CreateFeedRequest.Builderavoiding the need to create one manually viaCreateFeedRequest.builder()- Parameters:
createFeedRequest- AConsumerthat will call methods onCreateFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDictionary
default CompletableFuture<DeleteDictionaryResponse> deleteDictionary(DeleteDictionaryRequest deleteDictionaryRequest) Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.
- Parameters:
deleteDictionaryRequest-- Returns:
- A Java Future containing the result of the DeleteDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDictionary
default CompletableFuture<DeleteDictionaryResponse> deleteDictionary(Consumer<DeleteDictionaryRequest.Builder> deleteDictionaryRequest) Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.
This is a convenience which creates an instance of the
DeleteDictionaryRequest.Builderavoiding the need to create one manually viaDeleteDictionaryRequest.builder()- Parameters:
deleteDictionaryRequest- AConsumerthat will call methods onDeleteDictionaryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFeed
Deletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.
- Parameters:
deleteFeedRequest-- Returns:
- A Java Future containing the result of the DeleteFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFeed
default CompletableFuture<DeleteFeedResponse> deleteFeed(Consumer<DeleteFeedRequest.Builder> deleteFeedRequest) Deletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.
This is a convenience which creates an instance of the
DeleteFeedRequest.Builderavoiding the need to create one manually viaDeleteFeedRequest.builder()- Parameters:
deleteFeedRequest- AConsumerthat will call methods onDeleteFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFeed
default CompletableFuture<DisassociateFeedResponse> disassociateFeed(DisassociateFeedRequest disassociateFeedRequest) Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
- Parameters:
disassociateFeedRequest-- Returns:
- A Java Future containing the result of the DisassociateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFeed
default CompletableFuture<DisassociateFeedResponse> disassociateFeed(Consumer<DisassociateFeedRequest.Builder> disassociateFeedRequest) Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
This is a convenience which creates an instance of the
DisassociateFeedRequest.Builderavoiding the need to create one manually viaDisassociateFeedRequest.builder()- Parameters:
disassociateFeedRequest- AConsumerthat will call methods onDisassociateFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportDictionaryEntries
default CompletableFuture<ExportDictionaryEntriesResponse> exportDictionaryEntries(ExportDictionaryEntriesRequest exportDictionaryEntriesRequest) Exports the entries from the specified dictionary.
- Parameters:
exportDictionaryEntriesRequest-- Returns:
- A Java Future containing the result of the ExportDictionaryEntries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportDictionaryEntries
default CompletableFuture<ExportDictionaryEntriesResponse> exportDictionaryEntries(Consumer<ExportDictionaryEntriesRequest.Builder> exportDictionaryEntriesRequest) Exports the entries from the specified dictionary.
This is a convenience which creates an instance of the
ExportDictionaryEntriesRequest.Builderavoiding the need to create one manually viaExportDictionaryEntriesRequest.builder()- Parameters:
exportDictionaryEntriesRequest- AConsumerthat will call methods onExportDictionaryEntriesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ExportDictionaryEntries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDictionary
default CompletableFuture<GetDictionaryResponse> getDictionary(GetDictionaryRequest getDictionaryRequest) Retrieves information about the specified dictionary.
- Parameters:
getDictionaryRequest-- Returns:
- A Java Future containing the result of the GetDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDictionary
default CompletableFuture<GetDictionaryResponse> getDictionary(Consumer<GetDictionaryRequest.Builder> getDictionaryRequest) Retrieves information about the specified dictionary.
This is a convenience which creates an instance of the
GetDictionaryRequest.Builderavoiding the need to create one manually viaGetDictionaryRequest.builder()- Parameters:
getDictionaryRequest- AConsumerthat will call methods onGetDictionaryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFeed
Retrieves information about the specified feed.
- Parameters:
getFeedRequest-- Returns:
- A Java Future containing the result of the GetFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFeed
Retrieves information about the specified feed.
This is a convenience which creates an instance of the
GetFeedRequest.Builderavoiding the need to create one manually viaGetFeedRequest.builder()- Parameters:
getFeedRequest- AConsumerthat will call methods onGetFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDictionaries
default CompletableFuture<ListDictionariesResponse> listDictionaries(ListDictionariesRequest listDictionariesRequest) Lists the dictionaries in your account.
- Parameters:
listDictionariesRequest-- Returns:
- A Java Future containing the result of the ListDictionaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDictionaries
default CompletableFuture<ListDictionariesResponse> listDictionaries(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) Lists the dictionaries in your account.
This is a convenience which creates an instance of the
ListDictionariesRequest.Builderavoiding the need to create one manually viaListDictionariesRequest.builder()- Parameters:
listDictionariesRequest- AConsumerthat will call methods onListDictionariesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDictionaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDictionariesPaginator
default ListDictionariesPublisher listDictionariesPaginator(ListDictionariesRequest listDictionariesRequest) This is a variant of
listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elementalinference.paginators.ListDictionariesPublisher publisher = client.listDictionariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesPublisher publisher = client.listDictionariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse response) { //... }; });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
listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation.- Parameters:
listDictionariesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDictionariesPaginator
default ListDictionariesPublisher listDictionariesPaginator(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) This is a variant of
listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elementalinference.paginators.ListDictionariesPublisher publisher = client.listDictionariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesPublisher publisher = client.listDictionariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse response) { //... }; });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
listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest)operation.
This is a convenience which creates an instance of the
ListDictionariesRequest.Builderavoiding the need to create one manually viaListDictionariesRequest.builder()- Parameters:
listDictionariesRequest- AConsumerthat will call methods onListDictionariesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFeeds
Displays a list of feeds that belong to this AWS account.
- Parameters:
listFeedsRequest-- Returns:
- A Java Future containing the result of the ListFeeds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFeeds
default CompletableFuture<ListFeedsResponse> listFeeds(Consumer<ListFeedsRequest.Builder> listFeedsRequest) Displays a list of feeds that belong to this AWS account.
This is a convenience which creates an instance of the
ListFeedsRequest.Builderavoiding the need to create one manually viaListFeedsRequest.builder()- Parameters:
listFeedsRequest- AConsumerthat will call methods onListFeedsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFeeds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFeedsPaginator
This is a variant of
listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elementalinference.paginators.ListFeedsPublisher publisher = client.listFeedsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elementalinference.paginators.ListFeedsPublisher publisher = client.listFeedsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse response) { //... }; });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
listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation.- Parameters:
listFeedsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFeedsPaginator
This is a variant of
listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elementalinference.paginators.ListFeedsPublisher publisher = client.listFeedsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elementalinference.paginators.ListFeedsPublisher publisher = client.listFeedsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse response) { //... }; });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
listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest)operation.
This is a convenience which creates an instance of the
ListFeedsRequest.Builderavoiding the need to create one manually viaListFeedsRequest.builder()- Parameters:
listFeedsRequest- AConsumerthat will call methods onListFeedsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags that are on an Elemental Inference resource in the current region.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags that are on an Elemental Inference resource in the current region.
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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Associates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from the specified resource in the current region.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from the specified resource in the current region.
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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDictionary
default CompletableFuture<UpdateDictionaryResponse> updateDictionary(UpdateDictionaryRequest updateDictionaryRequest) Updates the specified dictionary.
- Parameters:
updateDictionaryRequest-- Returns:
- A Java Future containing the result of the UpdateDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDictionary
default CompletableFuture<UpdateDictionaryResponse> updateDictionary(Consumer<UpdateDictionaryRequest.Builder> updateDictionaryRequest) Updates the specified dictionary.
This is a convenience which creates an instance of the
UpdateDictionaryRequest.Builderavoiding the need to create one manually viaUpdateDictionaryRequest.builder()- Parameters:
updateDictionaryRequest- AConsumerthat will call methods onUpdateDictionaryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDictionary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFeed
Updates the name and/or outputs in a feed.
UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload.
This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify.
If you want to patch the array of outputs to make selective additions, use AssociateFeed.
- Parameters:
updateFeedRequest-- Returns:
- A Java Future containing the result of the UpdateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFeed
default CompletableFuture<UpdateFeedResponse> updateFeed(Consumer<UpdateFeedRequest.Builder> updateFeedRequest) Updates the name and/or outputs in a feed.
UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload.
This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify.
If you want to patch the array of outputs to make selective additions, use AssociateFeed.
This is a convenience which creates an instance of the
UpdateFeedRequest.Builderavoiding the need to create one manually viaUpdateFeedRequest.builder()- Parameters:
updateFeedRequest- AConsumerthat will call methods onUpdateFeedRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFeed operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
- ResourceNotFoundException The resource specified in the action doesn't exist.
- InternalServerErrorException An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
- AccessDeniedException You do not have sufficient access to perform this action.
- TooManyRequestException The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
- ConflictException The request could not be completed due to a conflict.
- ServiceQuotaExceededException The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElementalInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofElementalInferenceAsyncWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ElementalInferenceAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aElementalInferenceAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aElementalInferenceAsyncClient.
-