com.amazonaws.services.elasticinference

Class AmazonElasticInferenceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticinference.AmazonElasticInferenceClient

All Implemented Interfaces:

AmazonElasticInference

Direct Known Subclasses:

AmazonElasticInferenceAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonElasticInferenceClient
extends AmazonWebServiceClient
implements AmazonElasticInference

Client for accessing Amazon Elastic Inference. All service calls made using this client are blocking, and will not return until the service call completes.

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.elasticinference.AmazonElasticInference

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonElasticInferenceClientBuilder	builder()
DescribeAcceleratorOfferingsResult	describeAcceleratorOfferings(DescribeAcceleratorOfferingsRequest request) Describes the locations in which a given accelerator type or set of types is present in a given region.
DescribeAcceleratorsResult	describeAccelerators(DescribeAcceleratorsRequest request) Describes information over a provided set of accelerators belonging to an account.
DescribeAcceleratorTypesResult	describeAcceleratorTypes(DescribeAcceleratorTypesRequest request) Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns all tags of an Elastic Inference Accelerator.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to an Elastic Inference Accelerator.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from an Elastic Inference Accelerator.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonElasticInferenceClientBuilder builder()

describeAcceleratorOfferings

public DescribeAcceleratorOfferingsResult describeAcceleratorOfferings(DescribeAcceleratorOfferingsRequest request)

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.

Specified by:

describeAcceleratorOfferings in interface AmazonElasticInference

Parameters:

describeAcceleratorOfferingsRequest -

Returns:

Result of the DescribeAcceleratorOfferings operation returned by the service.

Throws:

BadRequestException - Raised when a malformed input has been provided to the API.

ResourceNotFoundException - Raised when the requested resource cannot be found.

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

describeAcceleratorTypes

public DescribeAcceleratorTypesResult describeAcceleratorTypes(DescribeAcceleratorTypesRequest request)

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.

Specified by:

describeAcceleratorTypes in interface AmazonElasticInference

Parameters:

describeAcceleratorTypesRequest -

Returns:

Result of the DescribeAcceleratorTypes operation returned by the service.

Throws:

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

describeAccelerators

public DescribeAcceleratorsResult describeAccelerators(DescribeAcceleratorsRequest request)

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.

Specified by:

describeAccelerators in interface AmazonElasticInference

Parameters:

describeAcceleratorsRequest -

Returns:

Result of the DescribeAccelerators operation returned by the service.

Throws:

BadRequestException - Raised when a malformed input has been provided to the API.

ResourceNotFoundException - Raised when the requested resource cannot be found.

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AmazonElasticInference

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - Raised when a malformed input has been provided to the API.

ResourceNotFoundException - Raised when the requested resource cannot be found.

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonElasticInference

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - Raised when a malformed input has been provided to the API.

ResourceNotFoundException - Raised when the requested resource cannot be found.

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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.

Specified by:

untagResource in interface AmazonElasticInference

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - Raised when a malformed input has been provided to the API.

ResourceNotFoundException - Raised when the requested resource cannot be found.

InternalServerException - Raised when an unexpected error occurred during request processing.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonElasticInference

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonElasticInference

Overrides:

shutdown in class AmazonWebServiceClient