cloudfrontkeyvaluestore/aws.sdk.kotlin.services.cloudfrontkeyvaluestore/CloudFrontKeyValueStoreClient

CloudFrontKeyValueStoreClient

interface CloudFrontKeyValueStoreClient : SdkClient

Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource

Types

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

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

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

Properties

abstract override val config: CloudFrontKeyValueStoreClient.Config

CloudFrontKeyValueStoreClient's configuration

Functions

abstract suspend fun deleteKey(input: DeleteKeyRequest): DeleteKeyResponse

Deletes the key value pair specified by the key.

describeKeyValueStore

abstract suspend fun describeKeyValueStore(input: DescribeKeyValueStoreRequest): DescribeKeyValueStoreResponse

Returns metadata information about Key Value Store.

abstract suspend fun getKey(input: GetKeyRequest): GetKeyResponse

Returns a key value pair.

abstract suspend fun listKeys(input: ListKeysRequest): ListKeysResponse

Returns a list of key value pairs.

abstract suspend fun putKey(input: PutKeyRequest): PutKeyResponse

Creates a new key value pair or replaces the value of an existing key.

abstract suspend fun updateKeys(input: UpdateKeysRequest): UpdateKeysResponse

Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Inherited functions

expect abstract fun close()

inline suspend fun CloudFrontKeyValueStoreClient.deleteKey(crossinline block: DeleteKeyRequest.Builder.() -> Unit): DeleteKeyResponse

Deletes the key value pair specified by the key.

describeKeyValueStore

inline suspend fun CloudFrontKeyValueStoreClient.describeKeyValueStore(crossinline block: DescribeKeyValueStoreRequest.Builder.() -> Unit): DescribeKeyValueStoreResponse

Returns metadata information about Key Value Store.

inline suspend fun CloudFrontKeyValueStoreClient.getKey(crossinline block: GetKeyRequest.Builder.() -> Unit): GetKeyResponse

Returns a key value pair.

inline suspend fun CloudFrontKeyValueStoreClient.listKeys(crossinline block: ListKeysRequest.Builder.() -> Unit): ListKeysResponse

Returns a list of key value pairs.

listKeysPaginated

fun CloudFrontKeyValueStoreClient.listKeysPaginated(initialRequest: ListKeysRequest): Flow<ListKeysResponse>

fun CloudFrontKeyValueStoreClient.listKeysPaginated(block: ListKeysRequest.Builder.() -> Unit): Flow<ListKeysResponse>

Paginate over ListKeysResponse results.

inline suspend fun CloudFrontKeyValueStoreClient.putKey(crossinline block: PutKeyRequest.Builder.() -> Unit): PutKeyResponse

Creates a new key value pair or replaces the value of an existing key.

inline suspend fun CloudFrontKeyValueStoreClient.updateKeys(crossinline block: UpdateKeysRequest.Builder.() -> Unit): UpdateKeysResponse

Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

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

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.