Interface ElementalInferenceClient

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 CreateFeedResponse	createFeed(Consumer<CreateFeedRequest.Builder> createFeedRequest)	Creates a feed.
default CreateFeedResponse	createFeed(CreateFeedRequest createFeedRequest)	Creates a feed.
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 (for example, an MediaLive channel) that is associated with this feed.
default DisassociateFeedResponse	disassociateFeed(DisassociateFeedRequest disassociateFeedRequest)	Releases the resource (for example, an MediaLive channel) that is associated with this feed.
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 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 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 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.

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 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.

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

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 live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.

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 live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.

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

deleteFeed

default DeleteFeedResponse deleteFeed(DeleteFeedRequest deleteFeedRequest)
                               throws ValidationException,
ResourceNotFoundException,
InternalServerErrorException,
AccessDeniedException,
TooManyRequestException,
ConflictException,
AwsServiceException,
SdkClientException,
ElementalInferenceException

Deletes the specified feed. The feed can be deleted at any time.

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. The feed can be deleted at any time.

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 (for example, an MediaLive channel) 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 (for example, an MediaLive channel) 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

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

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

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.

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.

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