uxc/aws.sdk.kotlin.services.uxc/UxcClient

UxcClient

This is the Amazon Web Services User Experience Customization (UXC) API Reference. Amazon Web Services User Experience Customization (UXC) is a utility that provides programmatic access to enable account administrators to customize the visual appearance of the Amazon Web Services Management Console and manage these settings at the account level.

The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.

For more information about UXC features and console procedures, see Getting started with Amazon Web Services User Experience Customization. For information about required permissions, see Identity and access management for Amazon Web Services Management Console.

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: UxcClient.Config

UxcClient's configuration

Functions

getAccountCustomizations

abstract suspend fun getAccountCustomizations(input: GetAccountCustomizationsRequest = GetAccountCustomizationsRequest { }): GetAccountCustomizationsResponse

Returns the current account customization settings, including account color, visible services, and visible Regions. Settings that you have not configured return their default values: visible Regions and visible services return null, and account color returns none.

listServices

abstract suspend fun listServices(input: ListServicesRequest = ListServicesRequest { }): ListServicesResponse

Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations. The available services vary by Amazon Web Services partition. Use pagination to retrieve all results.

updateAccountCustomizations

abstract suspend fun updateAccountCustomizations(input: UpdateAccountCustomizationsRequest = UpdateAccountCustomizationsRequest { }): UpdateAccountCustomizationsResponse

Updates one or more account customization settings. You can update account color, visible services, and visible Regions in a single request. Only the settings that you include in the request body are modified. Omitted settings remain unchanged. To reset a setting to its default behavior, set the value to null for visible Regions and visible services, or none for account color. This operation is idempotent.

Inherited functions

getAccountCustomizations

inline suspend fun UxcClient.getAccountCustomizations(crossinline block: GetAccountCustomizationsRequest.Builder.() -> Unit): GetAccountCustomizationsResponse

listServices

inline suspend fun UxcClient.listServices(crossinline block: ListServicesRequest.Builder.() -> Unit): ListServicesResponse

listServicesPaginated

fun UxcClient.listServicesPaginated(initialRequest: ListServicesRequest = ListServicesRequest { }): Flow<ListServicesResponse>

fun UxcClient.listServicesPaginated(block: ListServicesRequest.Builder.() -> Unit): Flow<ListServicesResponse>

Paginate over ListServicesResponse results.

updateAccountCustomizations

inline suspend fun UxcClient.updateAccountCustomizations(crossinline block: UpdateAccountCustomizationsRequest.Builder.() -> Unit): UpdateAccountCustomizationsResponse

withConfig

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

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.