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.default CompletableFuture<CreateFunctionResponse> createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) Creates a function.default CompletableFuture<CreateFunctionResponse> createFunction(CreateFunctionRequest createFunctionRequest) Creates a function.createQuestionSet(Consumer<CreateQuestionSetRequest.Builder> createQuestionSetRequest) Creates a question set.createQuestionSet(CreateQuestionSetRequest createQuestionSetRequest) Creates a question set.createQuestionSetVersion(Consumer<CreateQuestionSetVersionRequest.Builder> createQuestionSetVersionRequest) Publishes the DRAFT version of the specified question set as a new version.createQuestionSetVersion(CreateQuestionSetVersionRequest createQuestionSetVersionRequest) Publishes the DRAFT version of the specified question set as a new version.createScheduleAction(Consumer<CreateScheduleActionRequest.Builder> createScheduleActionRequest) Creates a schedule action on a feed.createScheduleAction(CreateScheduleActionRequest createScheduleActionRequest) Creates a schedule action on 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.deleteFeedPolicy(Consumer<DeleteFeedPolicyRequest.Builder> deleteFeedPolicyRequest) Deletes the resource-based policy attached to the specified feed.deleteFeedPolicy(DeleteFeedPolicyRequest deleteFeedPolicyRequest) Deletes the resource-based policy attached to the specified feed.default CompletableFuture<DeleteFunctionResponse> deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) Deletes a function.default CompletableFuture<DeleteFunctionResponse> deleteFunction(DeleteFunctionRequest deleteFunctionRequest) Deletes a function.deleteQuestionSet(Consumer<DeleteQuestionSetRequest.Builder> deleteQuestionSetRequest) Deletes the specified question set, including its DRAFT version and all its published versions.deleteQuestionSet(DeleteQuestionSetRequest deleteQuestionSetRequest) Deletes the specified question set, including its DRAFT version and all its published versions.deleteQuestionSetVersion(Consumer<DeleteQuestionSetVersionRequest.Builder> deleteQuestionSetVersionRequest) Deletes a published version of the specified question set.deleteQuestionSetVersion(DeleteQuestionSetVersionRequest deleteQuestionSetVersionRequest) Deletes a published version of the specified question set.deleteScheduleAction(Consumer<DeleteScheduleActionRequest.Builder> deleteScheduleActionRequest) Deletes a schedule action from a feed.deleteScheduleAction(DeleteScheduleActionRequest deleteScheduleActionRequest) Deletes a schedule action from a 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.default CompletableFuture<GetFeedPolicyResponse> getFeedPolicy(Consumer<GetFeedPolicyRequest.Builder> getFeedPolicyRequest) Retrieves the resource-based policy attached to the specified feed.default CompletableFuture<GetFeedPolicyResponse> getFeedPolicy(GetFeedPolicyRequest getFeedPolicyRequest) Retrieves the resource-based policy attached to the specified feed.default CompletableFuture<GetFixtureResponse> getFixture(Consumer<GetFixtureRequest.Builder> getFixtureRequest) Retrieves information about the specified fixture (a sports event, such as a specific basketball game).default CompletableFuture<GetFixtureResponse> getFixture(GetFixtureRequest getFixtureRequest) Retrieves information about the specified fixture (a sports event, such as a specific basketball game).default CompletableFuture<GetFunctionResponse> getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.default CompletableFuture<GetFunctionResponse> getFunction(GetFunctionRequest getFunctionRequest) Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.default CompletableFuture<GetQuestionSetResponse> getQuestionSet(Consumer<GetQuestionSetRequest.Builder> getQuestionSetRequest) Retrieves information about the specified question set at one version.default CompletableFuture<GetQuestionSetResponse> getQuestionSet(GetQuestionSetRequest getQuestionSetRequest) Retrieves information about the specified question set at one version.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.default CompletableFuture<ListFunctionsResponse> listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) Lists the functions in this account, in this Region.default CompletableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest listFunctionsRequest) Lists the functions in this account, in this Region.default ListFunctionsPublisherlistFunctionsPaginator(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) This is a variant oflistFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)operation.default ListFunctionsPublisherlistFunctionsPaginator(ListFunctionsRequest listFunctionsRequest) This is a variant oflistFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)operation.listQuestionSets(Consumer<ListQuestionSetsRequest.Builder> listQuestionSetsRequest) Lists the question sets in your account.listQuestionSets(ListQuestionSetsRequest listQuestionSetsRequest) Lists the question sets in your account.default ListQuestionSetsPublisherlistQuestionSetsPaginator(Consumer<ListQuestionSetsRequest.Builder> listQuestionSetsRequest) This is a variant oflistQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)operation.default ListQuestionSetsPublisherlistQuestionSetsPaginator(ListQuestionSetsRequest listQuestionSetsRequest) This is a variant oflistQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)operation.listQuestionSetVersions(Consumer<ListQuestionSetVersionsRequest.Builder> listQuestionSetVersionsRequest) Lists the versions of the specified question set.listQuestionSetVersions(ListQuestionSetVersionsRequest listQuestionSetVersionsRequest) Lists the versions of the specified question set.default ListQuestionSetVersionsPublisherlistQuestionSetVersionsPaginator(Consumer<ListQuestionSetVersionsRequest.Builder> listQuestionSetVersionsRequest) This is a variant oflistQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)operation.default ListQuestionSetVersionsPublisherlistQuestionSetVersionsPaginator(ListQuestionSetVersionsRequest listQuestionSetVersionsRequest) This is a variant oflistQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)operation.listScheduleActions(Consumer<ListScheduleActionsRequest.Builder> listScheduleActionsRequest) Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.listScheduleActions(ListScheduleActionsRequest listScheduleActionsRequest) Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.default ListScheduleActionsPublisherlistScheduleActionsPaginator(Consumer<ListScheduleActionsRequest.Builder> listScheduleActionsRequest) This is a variant oflistScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)operation.default ListScheduleActionsPublisherlistScheduleActionsPaginator(ListScheduleActionsRequest listScheduleActionsRequest) This is a variant oflistScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)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.default CompletableFuture<PutFeedPolicyResponse> putFeedPolicy(Consumer<PutFeedPolicyRequest.Builder> putFeedPolicyRequest) Attaches or replaces a resource-based policy on the specified feed.default CompletableFuture<PutFeedPolicyResponse> putFeedPolicy(PutFeedPolicyRequest putFeedPolicyRequest) Attaches or replaces a resource-based policy on the specified feed.default CompletableFuture<SearchFixturesResponse> searchFixtures(Consumer<SearchFixturesRequest.Builder> searchFixturesRequest) Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window.default CompletableFuture<SearchFixturesResponse> searchFixtures(SearchFixturesRequest searchFixturesRequest) Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window.default SearchFixturesPublishersearchFixturesPaginator(Consumer<SearchFixturesRequest.Builder> searchFixturesRequest) This is a variant ofsearchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)operation.default SearchFixturesPublishersearchFixturesPaginator(SearchFixturesRequest searchFixturesRequest) This is a variant ofsearchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)operation.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 CompletableFuture<UpdateFunctionResponse> updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) Updates a function.default CompletableFuture<UpdateFunctionResponse> updateFunction(UpdateFunctionRequest updateFunctionRequest) Updates a function.updateQuestionSet(Consumer<UpdateQuestionSetRequest.Builder> updateQuestionSetRequest) Updates the DRAFT version of the specified question set.updateQuestionSet(UpdateQuestionSetRequest updateQuestionSetRequest) Updates the DRAFT version of the specified question set.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:
-
createFunction
default CompletableFuture<CreateFunctionResponse> createFunction(CreateFunctionRequest createFunctionRequest) Creates a function. A function analyzes a feed by building a request from the feed's media and metadata, optionally sending that request to an Amazon Bedrock model in your account, and publishing the result to the feed's metadata timeline.
A function runs only after you attach it to a feed as a function output. For more information, see Using functions in the AWS Elemental Inference User Guide.
- Parameters:
createFunctionRequest-- Returns:
- A Java Future containing the result of the CreateFunction operation returned by the service.
The 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:
-
createFunction
default CompletableFuture<CreateFunctionResponse> createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) Creates a function. A function analyzes a feed by building a request from the feed's media and metadata, optionally sending that request to an Amazon Bedrock model in your account, and publishing the result to the feed's metadata timeline.
A function runs only after you attach it to a feed as a function output. For more information, see Using functions in the AWS Elemental Inference User Guide.
This is a convenience which creates an instance of the
CreateFunctionRequest.Builderavoiding the need to create one manually viaCreateFunctionRequest.builder()- Parameters:
createFunctionRequest- AConsumerthat will call methods onCreateFunctionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateFunction operation returned by the service.
The 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:
-
createQuestionSet
default CompletableFuture<CreateQuestionSetResponse> createQuestionSet(CreateQuestionSetRequest createQuestionSetRequest) Creates a question set. Use a question set to get answers about content that's specific to your business, in addition to the built-in contextual metadata classifications. A question set contains your own questions. You ask Elemental Inference these questions about each shot or scene of the media in a contextual metadata output, and Elemental Inference answers each question with scores. To use a question set, reference it in the customQuestions property of the contextual metadata configuration of a feed output.
CreateQuestionSet creates the question set with a DRAFT version that contains the questions in the request. To change DRAFT, use UpdateQuestionSet. To publish DRAFT as a numbered version, use CreateQuestionSetVersion. You can't change a published version.
A question set can contain the following types of questions. You must specify at least one question.
-
yesNo – Elemental Inference answers yes or no.
-
yesNoPerOption – Elemental Inference answers yes or no for each option.
-
chooseOne – Elemental Inference chooses one of the options.
A version can contain up to 100 scored items, where each yesNo question, each option of a yesNoPerOption question, and each chooseOne question counts as one item. The name of each question must be unique across all three types.
- Parameters:
createQuestionSetRequest-- Returns:
- A Java Future containing the result of the CreateQuestionSet operation returned by the service.
The 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:
-
-
createQuestionSet
default CompletableFuture<CreateQuestionSetResponse> createQuestionSet(Consumer<CreateQuestionSetRequest.Builder> createQuestionSetRequest) Creates a question set. Use a question set to get answers about content that's specific to your business, in addition to the built-in contextual metadata classifications. A question set contains your own questions. You ask Elemental Inference these questions about each shot or scene of the media in a contextual metadata output, and Elemental Inference answers each question with scores. To use a question set, reference it in the customQuestions property of the contextual metadata configuration of a feed output.
CreateQuestionSet creates the question set with a DRAFT version that contains the questions in the request. To change DRAFT, use UpdateQuestionSet. To publish DRAFT as a numbered version, use CreateQuestionSetVersion. You can't change a published version.
A question set can contain the following types of questions. You must specify at least one question.
-
yesNo – Elemental Inference answers yes or no.
-
yesNoPerOption – Elemental Inference answers yes or no for each option.
-
chooseOne – Elemental Inference chooses one of the options.
A version can contain up to 100 scored items, where each yesNo question, each option of a yesNoPerOption question, and each chooseOne question counts as one item. The name of each question must be unique across all three types.
This is a convenience which creates an instance of the
CreateQuestionSetRequest.Builderavoiding the need to create one manually viaCreateQuestionSetRequest.builder()- Parameters:
createQuestionSetRequest- AConsumerthat will call methods onCreateQuestionSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateQuestionSet operation returned by the service.
The 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:
-
-
createQuestionSetVersion
default CompletableFuture<CreateQuestionSetVersionResponse> createQuestionSetVersion(CreateQuestionSetVersionRequest createQuestionSetVersionRequest) Publishes the DRAFT version of the specified question set as a new version. The new version has the same name and questions as DRAFT, and you can't change it. DRAFT doesn't change, so you can continue to update it.
Version numbers start at 1, and each new version has the next number. Elemental Inference never reuses a version number, even after you delete that version.
If DRAFT hasn't changed since the latest published version, Elemental Inference doesn't create a version. Instead, it returns the latest version. A change to the name of the question set counts as a change to DRAFT.
A question set can have a limited number of versions. If the question set already has the maximum number of versions, Elemental Inference returns ServiceQuotaExceededException. To free space for a new version, delete a version that you no longer need, or create a new question set.
- Parameters:
createQuestionSetVersionRequest-- Returns:
- A Java Future containing the result of the CreateQuestionSetVersion operation returned by the service.
The 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:
-
createQuestionSetVersion
default CompletableFuture<CreateQuestionSetVersionResponse> createQuestionSetVersion(Consumer<CreateQuestionSetVersionRequest.Builder> createQuestionSetVersionRequest) Publishes the DRAFT version of the specified question set as a new version. The new version has the same name and questions as DRAFT, and you can't change it. DRAFT doesn't change, so you can continue to update it.
Version numbers start at 1, and each new version has the next number. Elemental Inference never reuses a version number, even after you delete that version.
If DRAFT hasn't changed since the latest published version, Elemental Inference doesn't create a version. Instead, it returns the latest version. A change to the name of the question set counts as a change to DRAFT.
A question set can have a limited number of versions. If the question set already has the maximum number of versions, Elemental Inference returns ServiceQuotaExceededException. To free space for a new version, delete a version that you no longer need, or create a new question set.
This is a convenience which creates an instance of the
CreateQuestionSetVersionRequest.Builderavoiding the need to create one manually viaCreateQuestionSetVersionRequest.builder()- Parameters:
createQuestionSetVersionRequest- AConsumerthat will call methods onCreateQuestionSetVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateQuestionSetVersion operation returned by the service.
The 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:
-
createScheduleAction
default CompletableFuture<CreateScheduleActionResponse> createScheduleAction(CreateScheduleActionRequest createScheduleActionRequest) Creates a schedule action on a feed. A schedule action applies configuration changes to the feed at a time that you specify, in the same way as an UpdateFeed request.
Elemental Inference validates the targets of the action when you create it.
- Parameters:
createScheduleActionRequest-- Returns:
- A Java Future containing the result of the CreateScheduleAction operation returned by the service.
The 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:
-
createScheduleAction
default CompletableFuture<CreateScheduleActionResponse> createScheduleAction(Consumer<CreateScheduleActionRequest.Builder> createScheduleActionRequest) Creates a schedule action on a feed. A schedule action applies configuration changes to the feed at a time that you specify, in the same way as an UpdateFeed request.
Elemental Inference validates the targets of the action when you create it.
This is a convenience which creates an instance of the
CreateScheduleActionRequest.Builderavoiding the need to create one manually viaCreateScheduleActionRequest.builder()- Parameters:
createScheduleActionRequest- AConsumerthat will call methods onCreateScheduleActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateScheduleAction operation returned by the service.
The 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:
-
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:
-
deleteFeedPolicy
default CompletableFuture<DeleteFeedPolicyResponse> deleteFeedPolicy(DeleteFeedPolicyRequest deleteFeedPolicyRequest) Deletes the resource-based policy attached to the specified feed. After you delete the policy, the operation revokes the cross-account access that the policy granted.
- Parameters:
deleteFeedPolicyRequest-- Returns:
- A Java Future containing the result of the DeleteFeedPolicy operation returned by the service.
The 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:
-
deleteFeedPolicy
default CompletableFuture<DeleteFeedPolicyResponse> deleteFeedPolicy(Consumer<DeleteFeedPolicyRequest.Builder> deleteFeedPolicyRequest) Deletes the resource-based policy attached to the specified feed. After you delete the policy, the operation revokes the cross-account access that the policy granted.
This is a convenience which creates an instance of the
DeleteFeedPolicyRequest.Builderavoiding the need to create one manually viaDeleteFeedPolicyRequest.builder()- Parameters:
deleteFeedPolicyRequest- AConsumerthat will call methods onDeleteFeedPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFeedPolicy operation returned by the service.
The 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:
-
deleteFunction
default CompletableFuture<DeleteFunctionResponse> deleteFunction(DeleteFunctionRequest deleteFunctionRequest) Deletes a function. If any feed still references the function, the operation returns a ConflictException. A disabled function output still references the function. Use GetFunction to find those feeds, then remove the function output from each one with UpdateFeed, or delete the feed, before retrying.
Deleting a function doesn't delete the metadata that it has already produced.
- Parameters:
deleteFunctionRequest-- Returns:
- A Java Future containing the result of the DeleteFunction operation returned by the service.
The 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:
-
deleteFunction
default CompletableFuture<DeleteFunctionResponse> deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) Deletes a function. If any feed still references the function, the operation returns a ConflictException. A disabled function output still references the function. Use GetFunction to find those feeds, then remove the function output from each one with UpdateFeed, or delete the feed, before retrying.
Deleting a function doesn't delete the metadata that it has already produced.
This is a convenience which creates an instance of the
DeleteFunctionRequest.Builderavoiding the need to create one manually viaDeleteFunctionRequest.builder()- Parameters:
deleteFunctionRequest- AConsumerthat will call methods onDeleteFunctionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFunction operation returned by the service.
The 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:
-
deleteQuestionSet
default CompletableFuture<DeleteQuestionSetResponse> deleteQuestionSet(DeleteQuestionSetRequest deleteQuestionSetRequest) Deletes the specified question set, including its DRAFT version and all its published versions. You can't delete a question set while any feed references any of its versions, including an archived feed. You must first remove the question set from the customQuestions configuration of each feed output that references it, or delete those feeds.
- Parameters:
deleteQuestionSetRequest-- Returns:
- A Java Future containing the result of the DeleteQuestionSet operation returned by the service.
The 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:
-
deleteQuestionSet
default CompletableFuture<DeleteQuestionSetResponse> deleteQuestionSet(Consumer<DeleteQuestionSetRequest.Builder> deleteQuestionSetRequest) Deletes the specified question set, including its DRAFT version and all its published versions. You can't delete a question set while any feed references any of its versions, including an archived feed. You must first remove the question set from the customQuestions configuration of each feed output that references it, or delete those feeds.
This is a convenience which creates an instance of the
DeleteQuestionSetRequest.Builderavoiding the need to create one manually viaDeleteQuestionSetRequest.builder()- Parameters:
deleteQuestionSetRequest- AConsumerthat will call methods onDeleteQuestionSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteQuestionSet operation returned by the service.
The 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:
-
deleteQuestionSetVersion
default CompletableFuture<DeleteQuestionSetVersionResponse> deleteQuestionSetVersion(DeleteQuestionSetVersionRequest deleteQuestionSetVersionRequest) Deletes a published version of the specified question set. You can't delete a version while a feed references it, including an archived feed. You can't restore a deleted version, and Elemental Inference doesn't reuse its number.
You can't delete the DRAFT version on its own. To delete DRAFT, delete the question set by using DeleteQuestionSet.
Deleting a version doesn't change the latestVersion of the question set, even if you delete the highest version.
- Parameters:
deleteQuestionSetVersionRequest-- Returns:
- A Java Future containing the result of the DeleteQuestionSetVersion operation returned by the service.
The 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:
-
deleteQuestionSetVersion
default CompletableFuture<DeleteQuestionSetVersionResponse> deleteQuestionSetVersion(Consumer<DeleteQuestionSetVersionRequest.Builder> deleteQuestionSetVersionRequest) Deletes a published version of the specified question set. You can't delete a version while a feed references it, including an archived feed. You can't restore a deleted version, and Elemental Inference doesn't reuse its number.
You can't delete the DRAFT version on its own. To delete DRAFT, delete the question set by using DeleteQuestionSet.
Deleting a version doesn't change the latestVersion of the question set, even if you delete the highest version.
This is a convenience which creates an instance of the
DeleteQuestionSetVersionRequest.Builderavoiding the need to create one manually viaDeleteQuestionSetVersionRequest.builder()- Parameters:
deleteQuestionSetVersionRequest- AConsumerthat will call methods onDeleteQuestionSetVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteQuestionSetVersion operation returned by the service.
The 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:
-
deleteScheduleAction
default CompletableFuture<DeleteScheduleActionResponse> deleteScheduleAction(DeleteScheduleActionRequest deleteScheduleActionRequest) Deletes a schedule action from a feed. A deleted action never runs.
You can delete only an action whose status is PENDING. Deleting an action doesn't reverse changes that the action already made to the feed. When you delete or archive a feed, Elemental Inference deletes all the schedule actions on that feed.
- Parameters:
deleteScheduleActionRequest-- Returns:
- A Java Future containing the result of the DeleteScheduleAction operation returned by the service.
The 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:
-
deleteScheduleAction
default CompletableFuture<DeleteScheduleActionResponse> deleteScheduleAction(Consumer<DeleteScheduleActionRequest.Builder> deleteScheduleActionRequest) Deletes a schedule action from a feed. A deleted action never runs.
You can delete only an action whose status is PENDING. Deleting an action doesn't reverse changes that the action already made to the feed. When you delete or archive a feed, Elemental Inference deletes all the schedule actions on that feed.
This is a convenience which creates an instance of the
DeleteScheduleActionRequest.Builderavoiding the need to create one manually viaDeleteScheduleActionRequest.builder()- Parameters:
deleteScheduleActionRequest- AConsumerthat will call methods onDeleteScheduleActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteScheduleAction operation returned by the service.
The 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:
-
getFeedPolicy
default CompletableFuture<GetFeedPolicyResponse> getFeedPolicy(GetFeedPolicyRequest getFeedPolicyRequest) Retrieves the resource-based policy attached to the specified feed.
- Parameters:
getFeedPolicyRequest-- Returns:
- A Java Future containing the result of the GetFeedPolicy operation returned by the service.
The 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:
-
getFeedPolicy
default CompletableFuture<GetFeedPolicyResponse> getFeedPolicy(Consumer<GetFeedPolicyRequest.Builder> getFeedPolicyRequest) Retrieves the resource-based policy attached to the specified feed.
This is a convenience which creates an instance of the
GetFeedPolicyRequest.Builderavoiding the need to create one manually viaGetFeedPolicyRequest.builder()- Parameters:
getFeedPolicyRequest- AConsumerthat will call methods onGetFeedPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFeedPolicy operation returned by the service.
The 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:
-
getFixture
Retrieves information about the specified fixture (a sports event, such as a specific basketball game). You obtain a fixtureId from SearchFixtures, or from the clipping output of a feed.
- Parameters:
getFixtureRequest-- Returns:
- A Java Future containing the result of the GetFixture operation returned by the service.
The 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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
getFixture
default CompletableFuture<GetFixtureResponse> getFixture(Consumer<GetFixtureRequest.Builder> getFixtureRequest) Retrieves information about the specified fixture (a sports event, such as a specific basketball game). You obtain a fixtureId from SearchFixtures, or from the clipping output of a feed.
This is a convenience which creates an instance of the
GetFixtureRequest.Builderavoiding the need to create one manually viaGetFixtureRequest.builder()- Parameters:
getFixtureRequest- AConsumerthat will call methods onGetFixtureRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFixture operation returned by the service.
The 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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
getFunction
Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.
- Parameters:
getFunctionRequest-- Returns:
- A Java Future containing the result of the GetFunction operation returned by the service.
The 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:
-
getFunction
default CompletableFuture<GetFunctionResponse> getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.
This is a convenience which creates an instance of the
GetFunctionRequest.Builderavoiding the need to create one manually viaGetFunctionRequest.builder()- Parameters:
getFunctionRequest- AConsumerthat will call methods onGetFunctionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFunction operation returned by the service.
The 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:
-
getQuestionSet
default CompletableFuture<GetQuestionSetResponse> getQuestionSet(GetQuestionSetRequest getQuestionSetRequest) Retrieves information about the specified question set at one version. By default, GetQuestionSet returns the DRAFT version. To retrieve a published version, specify questionSetVersion.
- Parameters:
getQuestionSetRequest-- Returns:
- A Java Future containing the result of the GetQuestionSet operation returned by the service.
The 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:
-
getQuestionSet
default CompletableFuture<GetQuestionSetResponse> getQuestionSet(Consumer<GetQuestionSetRequest.Builder> getQuestionSetRequest) Retrieves information about the specified question set at one version. By default, GetQuestionSet returns the DRAFT version. To retrieve a published version, specify questionSetVersion.
This is a convenience which creates an instance of the
GetQuestionSetRequest.Builderavoiding the need to create one manually viaGetQuestionSetRequest.builder()- Parameters:
getQuestionSetRequest- AConsumerthat will call methods onGetQuestionSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetQuestionSet operation returned by the service.
The 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:
-
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:
-
listFunctions
default CompletableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest listFunctionsRequest) Lists the functions in this account, in this Region. Each entry is a summary. To get the expressions of a function, use GetFunction.
- Parameters:
listFunctionsRequest-- Returns:
- A Java Future containing the result of the ListFunctions operation returned by the service.
The 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:
-
listFunctions
default CompletableFuture<ListFunctionsResponse> listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) Lists the functions in this account, in this Region. Each entry is a summary. To get the expressions of a function, use GetFunction.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builderavoiding the need to create one manually viaListFunctionsRequest.builder()- Parameters:
listFunctionsRequest- AConsumerthat will call methods onListFunctionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFunctions operation returned by the service.
The 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:
-
listFunctionsPaginator
This is a variant of
listFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)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.ListFunctionsPublisher publisher = client.listFunctionsPaginator(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.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListFunctionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListFunctionsResponse 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
listFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)operation.- Parameters:
listFunctionsRequest-- 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:
-
listFunctionsPaginator
default ListFunctionsPublisher listFunctionsPaginator(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) This is a variant of
listFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)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.ListFunctionsPublisher publisher = client.listFunctionsPaginator(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.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListFunctionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListFunctionsResponse 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
listFunctions(software.amazon.awssdk.services.elementalinference.model.ListFunctionsRequest)operation.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builderavoiding the need to create one manually viaListFunctionsRequest.builder()- Parameters:
listFunctionsRequest- AConsumerthat will call methods onListFunctionsRequest.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:
-
listQuestionSetVersions
default CompletableFuture<ListQuestionSetVersionsResponse> listQuestionSetVersions(ListQuestionSetVersionsRequest listQuestionSetVersionsRequest) Lists the versions of the specified question set. The list starts with the DRAFT version, followed by the published versions from the highest version number to the lowest. The list doesn't include deleted versions.
The response doesn't include the questions in each version. To retrieve them, use GetQuestionSet and specify questionSetVersion.
- Parameters:
listQuestionSetVersionsRequest-- Returns:
- A Java Future containing the result of the ListQuestionSetVersions operation returned by the service.
The 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:
-
listQuestionSetVersions
default CompletableFuture<ListQuestionSetVersionsResponse> listQuestionSetVersions(Consumer<ListQuestionSetVersionsRequest.Builder> listQuestionSetVersionsRequest) Lists the versions of the specified question set. The list starts with the DRAFT version, followed by the published versions from the highest version number to the lowest. The list doesn't include deleted versions.
The response doesn't include the questions in each version. To retrieve them, use GetQuestionSet and specify questionSetVersion.
This is a convenience which creates an instance of the
ListQuestionSetVersionsRequest.Builderavoiding the need to create one manually viaListQuestionSetVersionsRequest.builder()- Parameters:
listQuestionSetVersionsRequest- AConsumerthat will call methods onListQuestionSetVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListQuestionSetVersions operation returned by the service.
The 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:
-
listQuestionSetVersionsPaginator
default ListQuestionSetVersionsPublisher listQuestionSetVersionsPaginator(ListQuestionSetVersionsRequest listQuestionSetVersionsRequest) This is a variant of
listQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)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.ListQuestionSetVersionsPublisher publisher = client.listQuestionSetVersionsPaginator(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.ListQuestionSetVersionsPublisher publisher = client.listQuestionSetVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsResponse 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
listQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)operation.- Parameters:
listQuestionSetVersionsRequest-- 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:
-
listQuestionSetVersionsPaginator
default ListQuestionSetVersionsPublisher listQuestionSetVersionsPaginator(Consumer<ListQuestionSetVersionsRequest.Builder> listQuestionSetVersionsRequest) This is a variant of
listQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)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.ListQuestionSetVersionsPublisher publisher = client.listQuestionSetVersionsPaginator(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.ListQuestionSetVersionsPublisher publisher = client.listQuestionSetVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsResponse 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
listQuestionSetVersions(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetVersionsRequest)operation.
This is a convenience which creates an instance of the
ListQuestionSetVersionsRequest.Builderavoiding the need to create one manually viaListQuestionSetVersionsRequest.builder()- Parameters:
listQuestionSetVersionsRequest- AConsumerthat will call methods onListQuestionSetVersionsRequest.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:
-
listQuestionSets
default CompletableFuture<ListQuestionSetsResponse> listQuestionSets(ListQuestionSetsRequest listQuestionSetsRequest) Lists the question sets in your account. The response doesn't include the questions in each question set. To retrieve them, use GetQuestionSet.
- Parameters:
listQuestionSetsRequest-- Returns:
- A Java Future containing the result of the ListQuestionSets operation returned by the service.
The 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:
-
listQuestionSets
default CompletableFuture<ListQuestionSetsResponse> listQuestionSets(Consumer<ListQuestionSetsRequest.Builder> listQuestionSetsRequest) Lists the question sets in your account. The response doesn't include the questions in each question set. To retrieve them, use GetQuestionSet.
This is a convenience which creates an instance of the
ListQuestionSetsRequest.Builderavoiding the need to create one manually viaListQuestionSetsRequest.builder()- Parameters:
listQuestionSetsRequest- AConsumerthat will call methods onListQuestionSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListQuestionSets operation returned by the service.
The 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:
-
listQuestionSetsPaginator
default ListQuestionSetsPublisher listQuestionSetsPaginator(ListQuestionSetsRequest listQuestionSetsRequest) This is a variant of
listQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)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.ListQuestionSetsPublisher publisher = client.listQuestionSetsPaginator(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.ListQuestionSetsPublisher publisher = client.listQuestionSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsResponse 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
listQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)operation.- Parameters:
listQuestionSetsRequest-- 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:
-
listQuestionSetsPaginator
default ListQuestionSetsPublisher listQuestionSetsPaginator(Consumer<ListQuestionSetsRequest.Builder> listQuestionSetsRequest) This is a variant of
listQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)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.ListQuestionSetsPublisher publisher = client.listQuestionSetsPaginator(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.ListQuestionSetsPublisher publisher = client.listQuestionSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsResponse 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
listQuestionSets(software.amazon.awssdk.services.elementalinference.model.ListQuestionSetsRequest)operation.
This is a convenience which creates an instance of the
ListQuestionSetsRequest.Builderavoiding the need to create one manually viaListQuestionSetsRequest.builder()- Parameters:
listQuestionSetsRequest- AConsumerthat will call methods onListQuestionSetsRequest.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:
-
listScheduleActions
default CompletableFuture<ListScheduleActionsResponse> listScheduleActions(ListScheduleActionsRequest listScheduleActionsRequest) Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.
Elemental Inference keeps an action whose status is COMPLETED or FAILED for about 48 hours after its scheduled time, and then deletes it automatically.
- Parameters:
listScheduleActionsRequest-- Returns:
- A Java Future containing the result of the ListScheduleActions operation returned by the service.
The 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:
-
listScheduleActions
default CompletableFuture<ListScheduleActionsResponse> listScheduleActions(Consumer<ListScheduleActionsRequest.Builder> listScheduleActionsRequest) Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.
Elemental Inference keeps an action whose status is COMPLETED or FAILED for about 48 hours after its scheduled time, and then deletes it automatically.
This is a convenience which creates an instance of the
ListScheduleActionsRequest.Builderavoiding the need to create one manually viaListScheduleActionsRequest.builder()- Parameters:
listScheduleActionsRequest- AConsumerthat will call methods onListScheduleActionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListScheduleActions operation returned by the service.
The 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:
-
listScheduleActionsPaginator
default ListScheduleActionsPublisher listScheduleActionsPaginator(ListScheduleActionsRequest listScheduleActionsRequest) This is a variant of
listScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)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.ListScheduleActionsPublisher publisher = client.listScheduleActionsPaginator(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.ListScheduleActionsPublisher publisher = client.listScheduleActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsResponse 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
listScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)operation.- Parameters:
listScheduleActionsRequest-- 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:
-
listScheduleActionsPaginator
default ListScheduleActionsPublisher listScheduleActionsPaginator(Consumer<ListScheduleActionsRequest.Builder> listScheduleActionsRequest) This is a variant of
listScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)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.ListScheduleActionsPublisher publisher = client.listScheduleActionsPaginator(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.ListScheduleActionsPublisher publisher = client.listScheduleActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsResponse 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
listScheduleActions(software.amazon.awssdk.services.elementalinference.model.ListScheduleActionsRequest)operation.
This is a convenience which creates an instance of the
ListScheduleActionsRequest.Builderavoiding the need to create one manually viaListScheduleActionsRequest.builder()- Parameters:
listScheduleActionsRequest- AConsumerthat will call methods onListScheduleActionsRequest.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:
-
putFeedPolicy
default CompletableFuture<PutFeedPolicyResponse> putFeedPolicy(PutFeedPolicyRequest putFeedPolicyRequest) Attaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.
- Parameters:
putFeedPolicyRequest-- Returns:
- A Java Future containing the result of the PutFeedPolicy operation returned by the service.
The 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:
-
putFeedPolicy
default CompletableFuture<PutFeedPolicyResponse> putFeedPolicy(Consumer<PutFeedPolicyRequest.Builder> putFeedPolicyRequest) Attaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.
This is a convenience which creates an instance of the
PutFeedPolicyRequest.Builderavoiding the need to create one manually viaPutFeedPolicyRequest.builder()- Parameters:
putFeedPolicyRequest- AConsumerthat will call methods onPutFeedPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutFeedPolicy operation returned by the service.
The 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:
-
searchFixtures
default CompletableFuture<SearchFixturesResponse> searchFixtures(SearchFixturesRequest searchFixturesRequest) Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window. Each fixture in the response includes a fixtureId that you specify in the clipping output of a feed, so that Elemental Inference maps the event data for that fixture onto the clipping metadata. This operation is paginated: if there are more fixtures than fit in one page, the response includes a nextToken that you pass in a subsequent request.
- Parameters:
searchFixturesRequest-- Returns:
- A Java Future containing the result of the SearchFixtures operation returned by the service.
The 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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
searchFixtures
default CompletableFuture<SearchFixturesResponse> searchFixtures(Consumer<SearchFixturesRequest.Builder> searchFixturesRequest) Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window. Each fixture in the response includes a fixtureId that you specify in the clipping output of a feed, so that Elemental Inference maps the event data for that fixture onto the clipping metadata. This operation is paginated: if there are more fixtures than fit in one page, the response includes a nextToken that you pass in a subsequent request.
This is a convenience which creates an instance of the
SearchFixturesRequest.Builderavoiding the need to create one manually viaSearchFixturesRequest.builder()- Parameters:
searchFixturesRequest- AConsumerthat will call methods onSearchFixturesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchFixtures operation returned by the service.
The 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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
searchFixturesPaginator
default SearchFixturesPublisher searchFixturesPaginator(SearchFixturesRequest searchFixturesRequest) This is a variant of
searchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)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.SearchFixturesPublisher publisher = client.searchFixturesPaginator(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.SearchFixturesPublisher publisher = client.searchFixturesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.SearchFixturesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.SearchFixturesResponse 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
searchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)operation.- Parameters:
searchFixturesRequest-- 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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
searchFixturesPaginator
default SearchFixturesPublisher searchFixturesPaginator(Consumer<SearchFixturesRequest.Builder> searchFixturesRequest) This is a variant of
searchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)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.SearchFixturesPublisher publisher = client.searchFixturesPaginator(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.SearchFixturesPublisher publisher = client.searchFixturesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elementalinference.model.SearchFixturesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elementalinference.model.SearchFixturesResponse 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
searchFixtures(software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest)operation.
This is a convenience which creates an instance of the
SearchFixturesRequest.Builderavoiding the need to create one manually viaSearchFixturesRequest.builder()- Parameters:
searchFixturesRequest- AConsumerthat will call methods onSearchFixturesRequest.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.
- ServiceUnavailableException The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
- 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.
- GatewayTimedOutException The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:
-
updateFunction
default CompletableFuture<UpdateFunctionResponse> updateFunction(UpdateFunctionRequest updateFunctionRequest) Updates a function. Include only the parameters that you want to change; parameters that you don't include aren't affected. Elemental Inference validates the updated expressions in the same way as CreateFunction.
While a feed references the function, you can change only its expressions and its description, and you can set eventBridgeDelivery to DISABLED but not to ENABLED. The request expression must keep referencing the same media context, as reported in contextTypes. Changing an expression changes the behavior of every feed that references the function.
- Parameters:
updateFunctionRequest-- Returns:
- A Java Future containing the result of the UpdateFunction operation returned by the service.
The 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:
-
updateFunction
default CompletableFuture<UpdateFunctionResponse> updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) Updates a function. Include only the parameters that you want to change; parameters that you don't include aren't affected. Elemental Inference validates the updated expressions in the same way as CreateFunction.
While a feed references the function, you can change only its expressions and its description, and you can set eventBridgeDelivery to DISABLED but not to ENABLED. The request expression must keep referencing the same media context, as reported in contextTypes. Changing an expression changes the behavior of every feed that references the function.
This is a convenience which creates an instance of the
UpdateFunctionRequest.Builderavoiding the need to create one manually viaUpdateFunctionRequest.builder()- Parameters:
updateFunctionRequest- AConsumerthat will call methods onUpdateFunctionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFunction operation returned by the service.
The 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:
-
updateQuestionSet
default CompletableFuture<UpdateQuestionSetResponse> updateQuestionSet(UpdateQuestionSetRequest updateQuestionSetRequest) Updates the DRAFT version of the specified question set. UpdateQuestionSet doesn't create a version and doesn't change published versions. To publish the updated DRAFT as a new version, use CreateQuestionSetVersion.
UpdateQuestionSet replaces questions one type at a time. For each of yesNo, yesNoPerOption, and chooseOne: if you omit the array, DRAFT keeps its questions of that type. If you include the array, it replaces all the questions of that type in DRAFT. If you include an empty array, DRAFT no longer has questions of that type. The updated DRAFT must follow the same rules as in CreateQuestionSet, and Elemental Inference applies those rules to the questions that DRAFT keeps as well as to the questions in the request.
Feeds that reference the DRAFT version use the updated questions. To make sure that the questions for a feed don't change, reference a published version instead.
- Parameters:
updateQuestionSetRequest-- Returns:
- A Java Future containing the result of the UpdateQuestionSet operation returned by the service.
The 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:
-
updateQuestionSet
default CompletableFuture<UpdateQuestionSetResponse> updateQuestionSet(Consumer<UpdateQuestionSetRequest.Builder> updateQuestionSetRequest) Updates the DRAFT version of the specified question set. UpdateQuestionSet doesn't create a version and doesn't change published versions. To publish the updated DRAFT as a new version, use CreateQuestionSetVersion.
UpdateQuestionSet replaces questions one type at a time. For each of yesNo, yesNoPerOption, and chooseOne: if you omit the array, DRAFT keeps its questions of that type. If you include the array, it replaces all the questions of that type in DRAFT. If you include an empty array, DRAFT no longer has questions of that type. The updated DRAFT must follow the same rules as in CreateQuestionSet, and Elemental Inference applies those rules to the questions that DRAFT keeps as well as to the questions in the request.
Feeds that reference the DRAFT version use the updated questions. To make sure that the questions for a feed don't change, reference a published version instead.
This is a convenience which creates an instance of the
UpdateQuestionSetRequest.Builderavoiding the need to create one manually viaUpdateQuestionSetRequest.builder()- Parameters:
updateQuestionSetRequest- AConsumerthat will call methods onUpdateQuestionSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateQuestionSet operation returned by the service.
The 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:
-
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.
-