mediastoredata/aws.sdk.kotlin.services.mediastoredata/MediaStoreDataClient

MediaStoreDataClient

interface MediaStoreDataClient : SdkClient

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: MediaStoreDataClient.Config

MediaStoreDataClient's configuration

Functions

deleteObject

abstract suspend fun deleteObject(input: DeleteObjectRequest): DeleteObjectResponse

Deletes an object at the specified path.

describeObject

abstract suspend fun describeObject(input: DescribeObjectRequest): DescribeObjectResponse

Gets the headers for an object at the specified path.

getObject

abstract suspend fun <T> getObject(input: GetObjectRequest, block: suspend (GetObjectResponse) -> T): T

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

listItems

abstract suspend fun listItems(input: ListItemsRequest = ListItemsRequest { }): ListItemsResponse

Provides a list of metadata entries about folders and objects in the specified folder.

putObject

abstract suspend fun putObject(input: PutObjectRequest): PutObjectResponse

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

Inherited functions

expect abstract fun close()

deleteObject

inline suspend fun MediaStoreDataClient.deleteObject(crossinline block: DeleteObjectRequest.Builder.() -> Unit): DeleteObjectResponse

Deletes an object at the specified path.

describeObject

inline suspend fun MediaStoreDataClient.describeObject(crossinline block: DescribeObjectRequest.Builder.() -> Unit): DescribeObjectResponse

Gets the headers for an object at the specified path.

listItems

inline suspend fun MediaStoreDataClient.listItems(crossinline block: ListItemsRequest.Builder.() -> Unit): ListItemsResponse

Provides a list of metadata entries about folders and objects in the specified folder.

listItemsPaginated

fun MediaStoreDataClient.listItemsPaginated(initialRequest: ListItemsRequest = ListItemsRequest { }): Flow<ListItemsResponse>

fun MediaStoreDataClient.listItemsPaginated(block: ListItemsRequest.Builder.() -> Unit): Flow<ListItemsResponse>

Paginate over ListItemsResponse results.

putObject

inline suspend fun MediaStoreDataClient.putObject(crossinline block: PutObjectRequest.Builder.() -> Unit): PutObjectResponse

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

withConfig

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

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.