elasticinference/aws.sdk.kotlin.services.elasticinference/ElasticInferenceClient

ElasticInferenceClient

interface ElasticInferenceClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<ElasticInferenceClient.Config, ElasticInferenceClient.Config.Builder, ElasticInferenceClient>

Companion

object Companion : AbstractAwsSdkClientFactory<ElasticInferenceClient.Config, ElasticInferenceClient.Config.Builder, ElasticInferenceClient, ElasticInferenceClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: ElasticInferenceClient.Config

ElasticInferenceClient's configuration

Functions

describeAcceleratorOfferings

abstract suspend fun describeAcceleratorOfferings(input: DescribeAcceleratorOfferingsRequest): DescribeAcceleratorOfferingsResponse

Describes the locations in which a given accelerator type or set of types is present in a given region.

describeAccelerators

abstract suspend fun describeAccelerators(input: DescribeAcceleratorsRequest = DescribeAcceleratorsRequest { }): DescribeAcceleratorsResponse

Describes information over a provided set of accelerators belonging to an account.

describeAcceleratorTypes

abstract suspend fun describeAcceleratorTypes(input: DescribeAcceleratorTypesRequest = DescribeAcceleratorTypesRequest { }): DescribeAcceleratorTypesResponse

Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns all tags of an Elastic Inference Accelerator.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tags to an Elastic Inference Accelerator.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from an Elastic Inference Accelerator.

Inherited functions

expect abstract fun close()

describeAcceleratorOfferings

inline suspend fun ElasticInferenceClient.describeAcceleratorOfferings(crossinline block: DescribeAcceleratorOfferingsRequest.Builder.() -> Unit): DescribeAcceleratorOfferingsResponse

Describes the locations in which a given accelerator type or set of types is present in a given region.

describeAccelerators

inline suspend fun ElasticInferenceClient.describeAccelerators(crossinline block: DescribeAcceleratorsRequest.Builder.() -> Unit): DescribeAcceleratorsResponse

Describes information over a provided set of accelerators belonging to an account.

describeAcceleratorsPaginated

fun ElasticInferenceClient.describeAcceleratorsPaginated(initialRequest: DescribeAcceleratorsRequest = DescribeAcceleratorsRequest { }): Flow<DescribeAcceleratorsResponse>

fun ElasticInferenceClient.describeAcceleratorsPaginated(block: DescribeAcceleratorsRequest.Builder.() -> Unit): Flow<DescribeAcceleratorsResponse>

Paginate over DescribeAcceleratorsResponse results.

describeAcceleratorTypes

inline suspend fun ElasticInferenceClient.describeAcceleratorTypes(crossinline block: DescribeAcceleratorTypesRequest.Builder.() -> Unit): DescribeAcceleratorTypesResponse

Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.

listTagsForResource

inline suspend fun ElasticInferenceClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns all tags of an Elastic Inference Accelerator.

tagResource

inline suspend fun ElasticInferenceClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tags to an Elastic Inference Accelerator.

untagResource

inline suspend fun ElasticInferenceClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from an Elastic Inference Accelerator.

withConfig

fun ElasticInferenceClient.withConfig(block: ElasticInferenceClient.Config.Builder.() -> Unit): ElasticInferenceClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.