All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface ElementalInferenceClient extends AwsClient

Service client for accessing AWS Elemental Inference. This can be created using the static builder() method.

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

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

default AssociateFeedResponse

associateFeed(Consumer<AssociateFeedRequest.Builder> associateFeedRequest)

Associates a resource with the feed.

default AssociateFeedResponse

associateFeed(AssociateFeedRequest associateFeedRequest)

Associates a resource with the feed.

static ElementalInferenceClientBuilder

builder()

Create a builder that can be used to configure and create a ElementalInferenceClient.

static ElementalInferenceClient

create()

Create a ElementalInferenceClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

default CreateDictionaryResponse

createDictionary(Consumer<CreateDictionaryRequest.Builder> createDictionaryRequest)

Creates a custom dictionary for improving transcription accuracy.

default CreateDictionaryResponse

createDictionary(CreateDictionaryRequest createDictionaryRequest)

Creates a custom dictionary for improving transcription accuracy.

default CreateFeedResponse

createFeed(Consumer<CreateFeedRequest.Builder> createFeedRequest)

Creates a feed.

default CreateFeedResponse

createFeed(CreateFeedRequest createFeedRequest)

Creates a feed.

default DeleteDictionaryResponse

deleteDictionary(Consumer<DeleteDictionaryRequest.Builder> deleteDictionaryRequest)

Deletes the specified dictionary.

default DeleteDictionaryResponse

deleteDictionary(DeleteDictionaryRequest deleteDictionaryRequest)

Deletes the specified dictionary.

default DeleteFeedResponse

deleteFeed(Consumer<DeleteFeedRequest.Builder> deleteFeedRequest)

Deletes the specified feed.

default DeleteFeedResponse

deleteFeed(DeleteFeedRequest deleteFeedRequest)

Deletes the specified feed.

default DisassociateFeedResponse

disassociateFeed(Consumer<DisassociateFeedRequest.Builder> disassociateFeedRequest)

Releases the resource (the source media) that is associated with this feed.

default DisassociateFeedResponse

disassociateFeed(DisassociateFeedRequest disassociateFeedRequest)

Releases the resource (the source media) that is associated with this feed.

default ExportDictionaryEntriesResponse

exportDictionaryEntries(Consumer<ExportDictionaryEntriesRequest.Builder> exportDictionaryEntriesRequest)

Exports the entries from the specified dictionary.

default ExportDictionaryEntriesResponse

exportDictionaryEntries(ExportDictionaryEntriesRequest exportDictionaryEntriesRequest)

Exports the entries from the specified dictionary.

default GetDictionaryResponse

getDictionary(Consumer<GetDictionaryRequest.Builder> getDictionaryRequest)

Retrieves information about the specified dictionary.

default GetDictionaryResponse

getDictionary(GetDictionaryRequest getDictionaryRequest)

Retrieves information about the specified dictionary.

default GetFeedResponse

getFeed(Consumer<GetFeedRequest.Builder> getFeedRequest)

Retrieves information about the specified feed.

default GetFeedResponse

getFeed(GetFeedRequest getFeedRequest)

Retrieves information about the specified feed.

default ListDictionariesResponse

listDictionaries(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest)

Lists the dictionaries in your account.

default ListDictionariesResponse

listDictionaries(ListDictionariesRequest listDictionariesRequest)

Lists the dictionaries in your account.

default ListDictionariesIterable

listDictionariesPaginator(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest)

This is a variant of listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation.

default ListDictionariesIterable

listDictionariesPaginator(ListDictionariesRequest listDictionariesRequest)

This is a variant of listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation.

default ListFeedsResponse

listFeeds(Consumer<ListFeedsRequest.Builder> listFeedsRequest)

Displays a list of feeds that belong to this AWS account.

default ListFeedsResponse

listFeeds(ListFeedsRequest listFeedsRequest)

Displays a list of feeds that belong to this AWS account.

default ListFeedsIterable

listFeedsPaginator(Consumer<ListFeedsRequest.Builder> listFeedsRequest)

This is a variant of listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation.

default ListFeedsIterable

listFeedsPaginator(ListFeedsRequest listFeedsRequest)

This is a variant of listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation.

default ListTagsForResourceResponse

listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

List all tags that are on an Elemental Inference resource in the current region.

default ListTagsForResourceResponse

listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List all tags that are on an Elemental Inference resource in the current region.

default ElementalInferenceServiceClientConfiguration

serviceClientConfiguration()

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

static ServiceMetadata

serviceMetadata()

default TagResourceResponse

tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Associates the specified tags to the resource identified by the specified resourceArn in the current region.

default TagResourceResponse

tagResource(TagResourceRequest tagResourceRequest)

Associates the specified tags to the resource identified by the specified resourceArn in the current region.

default UntagResourceResponse

untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Deletes specified tags from the specified resource in the current region.

default UntagResourceResponse

untagResource(UntagResourceRequest untagResourceRequest)

Deletes specified tags from the specified resource in the current region.

default UpdateDictionaryResponse

updateDictionary(Consumer<UpdateDictionaryRequest.Builder> updateDictionaryRequest)

Updates the specified dictionary.

default UpdateDictionaryResponse

updateDictionary(UpdateDictionaryRequest updateDictionaryRequest)

Updates the specified dictionary.

default UpdateFeedResponse

updateFeed(Consumer<UpdateFeedRequest.Builder> updateFeedRequest)

Updates the name and/or outputs in a feed.

default UpdateFeedResponse

updateFeed(UpdateFeedRequest updateFeedRequest)

Updates the name and/or outputs in a feed.

default ElementalInferenceWaiter

waiter()

Create an instance of ElementalInferenceWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Field Details
- SERVICE_NAME
  static final String SERVICE_NAME
  
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  
  See Also:
  
  Constant Field Values
Method Details
- associateFeed
  default AssociateFeedResponse associateFeed(AssociateFeedRequest associateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the AssociateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- associateFeed
  default AssociateFeedResponse associateFeed(Consumer<AssociateFeedRequest.Builder> associateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via AssociateFeedRequest.builder()
  
  Parameters:
  
  associateFeedRequest - A Consumer that will call methods on AssociateFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the AssociateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createDictionary
  default CreateDictionaryResponse createDictionary(CreateDictionaryRequest createDictionaryRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the CreateDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createDictionary
  default CreateDictionaryResponse createDictionary(Consumer<CreateDictionaryRequest.Builder> createDictionaryRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via CreateDictionaryRequest.builder()
  
  Parameters:
  
  createDictionaryRequest - A Consumer that will call methods on CreateDictionaryRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createFeed
  default CreateFeedResponse createFeed(CreateFeedRequest createFeedRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the CreateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createFeed
  default CreateFeedResponse createFeed(Consumer<CreateFeedRequest.Builder> createFeedRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via CreateFeedRequest.builder()
  
  Parameters:
  
  createFeedRequest - A Consumer that will call methods on CreateFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteDictionary
  default DeleteDictionaryResponse deleteDictionary(DeleteDictionaryRequest deleteDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the DeleteDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteDictionary
  default DeleteDictionaryResponse deleteDictionary(Consumer<DeleteDictionaryRequest.Builder> deleteDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via DeleteDictionaryRequest.builder()
  
  Parameters:
  
  deleteDictionaryRequest - A Consumer that will call methods on DeleteDictionaryRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteFeed
  default DeleteFeedResponse deleteFeed(DeleteFeedRequest deleteFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the DeleteFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteFeed
  default DeleteFeedResponse deleteFeed(Consumer<DeleteFeedRequest.Builder> deleteFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via DeleteFeedRequest.builder()
  
  Parameters:
  
  deleteFeedRequest - A Consumer that will call methods on DeleteFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- disassociateFeed
  default DisassociateFeedResponse disassociateFeed(DisassociateFeedRequest disassociateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
  
  Parameters:
  
  disassociateFeedRequest -
  
  Returns:
  
  Result of the DisassociateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- disassociateFeed
  default DisassociateFeedResponse disassociateFeed(Consumer<DisassociateFeedRequest.Builder> disassociateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via DisassociateFeedRequest.builder()
  
  Parameters:
  
  disassociateFeedRequest - A Consumer that will call methods on DisassociateFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the DisassociateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- exportDictionaryEntries
  default ExportDictionaryEntriesResponse exportDictionaryEntries(ExportDictionaryEntriesRequest exportDictionaryEntriesRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Exports the entries from the specified dictionary.
  
  Parameters:
  
  exportDictionaryEntriesRequest -
  
  Returns:
  
  Result of the ExportDictionaryEntries operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- exportDictionaryEntries
  default ExportDictionaryEntriesResponse exportDictionaryEntries(Consumer<ExportDictionaryEntriesRequest.Builder> exportDictionaryEntriesRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Exports the entries from the specified dictionary.
  
  This is a convenience which creates an instance of the ExportDictionaryEntriesRequest.Builder avoiding the need to create one manually via ExportDictionaryEntriesRequest.builder()
  
  Parameters:
  
  exportDictionaryEntriesRequest - A Consumer that will call methods on ExportDictionaryEntriesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ExportDictionaryEntries operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getDictionary
  default GetDictionaryResponse getDictionary(GetDictionaryRequest getDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Retrieves information about the specified dictionary.
  
  Parameters:
  
  getDictionaryRequest -
  
  Returns:
  
  Result of the GetDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getDictionary
  default GetDictionaryResponse getDictionary(Consumer<GetDictionaryRequest.Builder> getDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Retrieves information about the specified dictionary.
  
  This is a convenience which creates an instance of the GetDictionaryRequest.Builder avoiding the need to create one manually via GetDictionaryRequest.builder()
  
  Parameters:
  
  getDictionaryRequest - A Consumer that will call methods on GetDictionaryRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getFeed
  default GetFeedResponse getFeed(GetFeedRequest getFeedRequest) throws ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Retrieves information about the specified feed.
  
  Parameters:
  
  getFeedRequest -
  
  Returns:
  
  Result of the GetFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getFeed
  default GetFeedResponse getFeed(Consumer<GetFeedRequest.Builder> getFeedRequest) throws ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Retrieves information about the specified feed.
  
  This is a convenience which creates an instance of the GetFeedRequest.Builder avoiding the need to create one manually via GetFeedRequest.builder()
  
  Parameters:
  
  getFeedRequest - A Consumer that will call methods on GetFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listDictionaries
  default ListDictionariesResponse listDictionaries(ListDictionariesRequest listDictionariesRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Lists the dictionaries in your account.
  
  Parameters:
  
  listDictionariesRequest -
  
  Returns:
  
  Result of the ListDictionaries operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listDictionaries
  default ListDictionariesResponse listDictionaries(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Lists the dictionaries in your account.
  
  This is a convenience which creates an instance of the ListDictionariesRequest.Builder avoiding the need to create one manually via ListDictionariesRequest.builder()
  
  Parameters:
  
  listDictionariesRequest - A Consumer that will call methods on ListDictionariesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListDictionaries operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listDictionariesPaginator
  default ListDictionariesIterable listDictionariesPaginator(ListDictionariesRequest listDictionariesRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  This is a variant of listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client.listDictionariesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client .listDictionariesPaginator(request); for (software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client.listDictionariesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation.
  
  Parameters:
  
  listDictionariesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listDictionariesPaginator
  default ListDictionariesIterable listDictionariesPaginator(Consumer<ListDictionariesRequest.Builder> listDictionariesRequest) throws ValidationException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  This is a variant of listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client.listDictionariesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client .listDictionariesPaginator(request); for (software.amazon.awssdk.services.elementalinference.model.ListDictionariesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.elementalinference.paginators.ListDictionariesIterable responses = client.listDictionariesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listDictionaries(software.amazon.awssdk.services.elementalinference.model.ListDictionariesRequest) operation.
  
  This is a convenience which creates an instance of the ListDictionariesRequest.Builder avoiding the need to create one manually via ListDictionariesRequest.builder()
  
  Parameters:
  
  listDictionariesRequest - A Consumer that will call methods on ListDictionariesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listFeeds
  default ListFeedsResponse listFeeds(ListFeedsRequest listFeedsRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Displays a list of feeds that belong to this AWS account.
  
  Parameters:
  
  listFeedsRequest -
  
  Returns:
  
  Result of the ListFeeds operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listFeeds
  default ListFeedsResponse listFeeds(Consumer<ListFeedsRequest.Builder> listFeedsRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Displays a list of feeds that belong to this AWS account.
  
  This is a convenience which creates an instance of the ListFeedsRequest.Builder avoiding the need to create one manually via ListFeedsRequest.builder()
  
  Parameters:
  
  listFeedsRequest - A Consumer that will call methods on ListFeedsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListFeeds operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listFeedsPaginator
  default ListFeedsIterable listFeedsPaginator(ListFeedsRequest listFeedsRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  This is a variant of listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client.listFeedsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client .listFeedsPaginator(request); for (software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client.listFeedsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation.
  
  Parameters:
  
  listFeedsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listFeedsPaginator
  default ListFeedsIterable listFeedsPaginator(Consumer<ListFeedsRequest.Builder> listFeedsRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  This is a variant of listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client.listFeedsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client .listFeedsPaginator(request); for (software.amazon.awssdk.services.elementalinference.model.ListFeedsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.elementalinference.paginators.ListFeedsIterable responses = client.listFeedsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listFeeds(software.amazon.awssdk.services.elementalinference.model.ListFeedsRequest) operation.
  
  This is a convenience which creates an instance of the ListFeedsRequest.Builder avoiding the need to create one manually via ListFeedsRequest.builder()
  
  Parameters:
  
  listFeedsRequest - A Consumer that will call methods on ListFeedsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  List all tags that are on an Elemental Inference resource in the current region.
  
  Parameters:
  
  listTagsForResourceRequest -
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()
  
  Parameters:
  
  listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via TagResourceRequest.builder()
  
  Parameters:
  
  tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Deletes specified tags from the specified resource in the current region.
  
  Parameters:
  
  untagResourceRequest -
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Deletes specified tags from the specified resource in the current region.
  
  This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()
  
  Parameters:
  
  untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateDictionary
  default UpdateDictionaryResponse updateDictionary(UpdateDictionaryRequest updateDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Updates the specified dictionary.
  
  Parameters:
  
  updateDictionaryRequest -
  
  Returns:
  
  Result of the UpdateDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateDictionary
  default UpdateDictionaryResponse updateDictionary(Consumer<UpdateDictionaryRequest.Builder> updateDictionaryRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  Updates the specified dictionary.
  
  This is a convenience which creates an instance of the UpdateDictionaryRequest.Builder avoiding the need to create one manually via UpdateDictionaryRequest.builder()
  
  Parameters:
  
  updateDictionaryRequest - A Consumer that will call methods on UpdateDictionaryRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateDictionary operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateFeed
  default UpdateFeedResponse updateFeed(UpdateFeedRequest updateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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:
  
  Result of the UpdateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateFeed
  default UpdateFeedResponse updateFeed(Consumer<UpdateFeedRequest.Builder> updateFeedRequest) throws ValidationException, ResourceNotFoundException, InternalServerErrorException, AccessDeniedException, TooManyRequestException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ElementalInferenceException
  
  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.Builder avoiding the need to create one manually via UpdateFeedRequest.builder()
  
  Parameters:
  
  updateFeedRequest - A Consumer that will call methods on UpdateFeedRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateFeed operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- waiter
  
  default ElementalInferenceWaiter waiter()
  
  Create an instance of ElementalInferenceWaiter using 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 ElementalInferenceWaiter
- create
  
  static ElementalInferenceClient create()
  
  Create a ElementalInferenceClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static ElementalInferenceClientBuilder builder()
  
  Create a builder that can be used to configure and create a ElementalInferenceClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- serviceClientConfiguration
  
  default ElementalInferenceServiceClientConfiguration serviceClientConfiguration()
  
  Description copied from interface: SdkClient
  
  The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
  
  Specified by:
  
  serviceClientConfiguration in interface AwsClient
  
  Specified by:
  
  serviceClientConfiguration in interface SdkClient
  
  Returns:
  
  SdkServiceClientConfiguration

Interface ElementalInferenceClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

associateFeed

associateFeed

createDictionary

createDictionary

createFeed

createFeed

deleteDictionary

deleteDictionary

deleteFeed

deleteFeed

disassociateFeed

disassociateFeed

exportDictionaryEntries

exportDictionaryEntries

getDictionary

getDictionary

getFeed

getFeed

listDictionaries

listDictionaries

listDictionariesPaginator

listDictionariesPaginator

listFeeds

listFeeds

listFeedsPaginator

listFeedsPaginator

listTagsForResource

listTagsForResource

tagResource

tagResource

untagResource

untagResource

updateDictionary

updateDictionary

updateFeed

updateFeed

waiter

create

builder

serviceMetadata

serviceClientConfiguration