Interface ElasticInferenceClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Elastic Inference public APIs.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aElasticInferenceClient
.static ElasticInferenceClient
create()
Create aElasticInferenceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.describeAcceleratorOfferings
(Consumer<DescribeAcceleratorOfferingsRequest.Builder> describeAcceleratorOfferingsRequest) Describes the locations in which a given accelerator type or set of types is present in a given region.describeAcceleratorOfferings
(DescribeAcceleratorOfferingsRequest describeAcceleratorOfferingsRequest) Describes the locations in which a given accelerator type or set of types is present in a given region.default DescribeAcceleratorsResponse
describeAccelerators
(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest) Describes information over a provided set of accelerators belonging to an account.default DescribeAcceleratorsResponse
describeAccelerators
(DescribeAcceleratorsRequest describeAcceleratorsRequest) Describes information over a provided set of accelerators belonging to an account.default DescribeAcceleratorsIterable
describeAcceleratorsPaginator
(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest) This is a variant ofdescribeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
operation.default DescribeAcceleratorsIterable
describeAcceleratorsPaginator
(DescribeAcceleratorsRequest describeAcceleratorsRequest) This is a variant ofdescribeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
operation.default DescribeAcceleratorTypesResponse
describeAcceleratorTypes
(Consumer<DescribeAcceleratorTypesRequest.Builder> describeAcceleratorTypesRequest) Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.default DescribeAcceleratorTypesResponse
describeAcceleratorTypes
(DescribeAcceleratorTypesRequest describeAcceleratorTypesRequest) Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all tags of an Elastic Inference Accelerator.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns all tags of an Elastic Inference Accelerator.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to an Elastic Inference Accelerator.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tags to an Elastic Inference Accelerator.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from an Elastic Inference Accelerator.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from an Elastic Inference Accelerator.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
describeAcceleratorOfferings
default DescribeAcceleratorOfferingsResponse describeAcceleratorOfferings(DescribeAcceleratorOfferingsRequest describeAcceleratorOfferingsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes the locations in which a given accelerator type or set of types is present in a given region.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
describeAcceleratorOfferingsRequest
-- Returns:
- Result of the DescribeAcceleratorOfferings operation returned by the service.
- See Also:
-
describeAcceleratorOfferings
default DescribeAcceleratorOfferingsResponse describeAcceleratorOfferings(Consumer<DescribeAcceleratorOfferingsRequest.Builder> describeAcceleratorOfferingsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes the locations in which a given accelerator type or set of types is present in a given region.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
DescribeAcceleratorOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorOfferingsRequest.builder()
- Parameters:
describeAcceleratorOfferingsRequest
- AConsumer
that will call methods onDescribeAcceleratorOfferingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAcceleratorOfferings operation returned by the service.
- See Also:
-
describeAcceleratorTypes
default DescribeAcceleratorTypesResponse describeAcceleratorTypes(DescribeAcceleratorTypesRequest describeAcceleratorTypesRequest) throws InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
describeAcceleratorTypesRequest
-- Returns:
- Result of the DescribeAcceleratorTypes operation returned by the service.
- See Also:
-
describeAcceleratorTypes
default DescribeAcceleratorTypesResponse describeAcceleratorTypes(Consumer<DescribeAcceleratorTypesRequest.Builder> describeAcceleratorTypesRequest) throws InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
DescribeAcceleratorTypesRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorTypesRequest.builder()
- Parameters:
describeAcceleratorTypesRequest
- AConsumer
that will call methods onDescribeAcceleratorTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAcceleratorTypes operation returned by the service.
- See Also:
-
describeAccelerators
default DescribeAcceleratorsResponse describeAccelerators(DescribeAcceleratorsRequest describeAcceleratorsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes information over a provided set of accelerators belonging to an account.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
describeAcceleratorsRequest
-- Returns:
- Result of the DescribeAccelerators operation returned by the service.
- See Also:
-
describeAccelerators
default DescribeAcceleratorsResponse describeAccelerators(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Describes information over a provided set of accelerators belonging to an account.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
DescribeAcceleratorsRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorsRequest.builder()
- Parameters:
describeAcceleratorsRequest
- AConsumer
that will call methods onDescribeAcceleratorsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccelerators operation returned by the service.
- See Also:
-
describeAcceleratorsPaginator
default DescribeAcceleratorsIterable describeAcceleratorsPaginator(DescribeAcceleratorsRequest describeAcceleratorsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException This is a variant of
describeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
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 Streamsoftware.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client.describeAcceleratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client .describeAcceleratorsPaginator(request); for (software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client.describeAcceleratorsPaginator(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
describeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
operation.- Parameters:
describeAcceleratorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAcceleratorsPaginator
default DescribeAcceleratorsIterable describeAcceleratorsPaginator(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException This is a variant of
describeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
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 Streamsoftware.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client.describeAcceleratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client .describeAcceleratorsPaginator(request); for (software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticinference.paginators.DescribeAcceleratorsIterable responses = client.describeAcceleratorsPaginator(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
describeAccelerators(software.amazon.awssdk.services.elasticinference.model.DescribeAcceleratorsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAcceleratorsRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorsRequest.builder()
- Parameters:
describeAcceleratorsRequest
- AConsumer
that will call methods onDescribeAcceleratorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Returns all tags of an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Returns all tags of an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Adds the specified tags to an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Adds the specified tags to an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Removes the specified tags from an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ElasticInferenceException Removes the specified tags from an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aElasticInferenceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aElasticInferenceClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-