workspacesweb/aws.sdk.kotlin.services.workspacesweb.model/WallpaperImageInput

WallpaperImageInput

sealed class WallpaperImageInput

The input for a wallpaper image. Provide the image as either a binary image file or an S3 URI. Maximum 5 MB in JPEG or PNG format.

Inheritors

Types

data class Blob(val value: ByteArray) : WallpaperImageInput

The image provided as a binary image file.

data class S3Uri(val value: String) : WallpaperImageInput

The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.

object SdkUnknown : WallpaperImageInput

Functions

fun asBlob(): ByteArray

Casts this WallpaperImageInput as a Blob and retrieves its kotlin.ByteArray value. Throws an exception if the WallpaperImageInput is not a Blob.

fun asBlobOrNull(): ByteArray?

Casts this WallpaperImageInput as a Blob and retrieves its kotlin.ByteArray value. Returns null if the WallpaperImageInput is not a Blob.

fun asS3Uri(): String

Casts this WallpaperImageInput as a S3Uri and retrieves its kotlin.String value. Throws an exception if the WallpaperImageInput is not a S3Uri.

fun asS3UriOrNull(): String?

Casts this WallpaperImageInput as a S3Uri and retrieves its kotlin.String value. Returns null if the WallpaperImageInput is not a S3Uri.