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

IconImageInput

The input for an icon image (logo or favicon). Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

Inheritors

Blob

S3Uri

SdkUnknown

Types

Blob

data class Blob(val value: ByteArray) : IconImageInput

The image provided as a binary image file.

S3Uri

data class S3Uri(val value: String) : IconImageInput

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.

SdkUnknown

object SdkUnknown : IconImageInput

Functions

asBlob

fun asBlob(): ByteArray

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

asBlobOrNull

fun asBlobOrNull(): ByteArray?

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

asS3Uri

fun asS3Uri(): String

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

asS3UriOrNull

fun asS3UriOrNull(): String?

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