ssmquicksetup/aws.sdk.kotlin.services.ssmquicksetup/SsmQuickSetupClient

SsmQuickSetupClient

interface SsmQuickSetupClient : SdkClient

Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services, including Systems Manager, by automating common or recommended tasks.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: SsmQuickSetupClient.Config

SsmQuickSetupClient's configuration

Functions

createConfigurationManager

abstract suspend fun createConfigurationManager(input: CreateConfigurationManagerRequest): CreateConfigurationManagerResponse

Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.

deleteConfigurationManager

abstract suspend fun deleteConfigurationManager(input: DeleteConfigurationManagerRequest): DeleteConfigurationManagerResponse

Deletes a configuration manager.

getConfiguration

abstract suspend fun getConfiguration(input: GetConfigurationRequest): GetConfigurationResponse

Returns details about the specified configuration.

getConfigurationManager

abstract suspend fun getConfigurationManager(input: GetConfigurationManagerRequest): GetConfigurationManagerResponse

Returns a configuration manager.

getServiceSettings

abstract suspend fun getServiceSettings(input: GetServiceSettingsRequest = GetServiceSettingsRequest { }): GetServiceSettingsResponse

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

listConfigurationManagers

abstract suspend fun listConfigurationManagers(input: ListConfigurationManagersRequest = ListConfigurationManagersRequest { }): ListConfigurationManagersResponse

Returns Quick Setup configuration managers.

listConfigurations

abstract suspend fun listConfigurations(input: ListConfigurationsRequest = ListConfigurationsRequest { }): ListConfigurationsResponse

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

listQuickSetupTypes

abstract suspend fun listQuickSetupTypes(input: ListQuickSetupTypesRequest = ListQuickSetupTypesRequest { }): ListQuickSetupTypesResponse

Returns the available Quick Setup types.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns tags assigned to the resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns key-value pairs of metadata to Amazon Web Services resources.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the specified resource.

updateConfigurationDefinition

abstract suspend fun updateConfigurationDefinition(input: UpdateConfigurationDefinitionRequest): UpdateConfigurationDefinitionResponse

Updates a Quick Setup configuration definition.

updateConfigurationManager

abstract suspend fun updateConfigurationManager(input: UpdateConfigurationManagerRequest): UpdateConfigurationManagerResponse

Updates a Quick Setup configuration manager.

updateServiceSettings

abstract suspend fun updateServiceSettings(input: UpdateServiceSettingsRequest = UpdateServiceSettingsRequest { }): UpdateServiceSettingsResponse

Updates settings configured for Quick Setup.

Inherited functions

expect abstract fun close()

createConfigurationManager

inline suspend fun SsmQuickSetupClient.createConfigurationManager(crossinline block: CreateConfigurationManagerRequest.Builder.() -> Unit): CreateConfigurationManagerResponse

deleteConfigurationManager

inline suspend fun SsmQuickSetupClient.deleteConfigurationManager(crossinline block: DeleteConfigurationManagerRequest.Builder.() -> Unit): DeleteConfigurationManagerResponse

Deletes a configuration manager.

getConfiguration

inline suspend fun SsmQuickSetupClient.getConfiguration(crossinline block: GetConfigurationRequest.Builder.() -> Unit): GetConfigurationResponse

Returns details about the specified configuration.

getConfigurationManager

inline suspend fun SsmQuickSetupClient.getConfigurationManager(crossinline block: GetConfigurationManagerRequest.Builder.() -> Unit): GetConfigurationManagerResponse

Returns a configuration manager.

getServiceSettings

inline suspend fun SsmQuickSetupClient.getServiceSettings(crossinline block: GetServiceSettingsRequest.Builder.() -> Unit): GetServiceSettingsResponse

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

listConfigurationManagers

inline suspend fun SsmQuickSetupClient.listConfigurationManagers(crossinline block: ListConfigurationManagersRequest.Builder.() -> Unit): ListConfigurationManagersResponse

Returns Quick Setup configuration managers.

listConfigurationManagersPaginated

fun SsmQuickSetupClient.listConfigurationManagersPaginated(initialRequest: ListConfigurationManagersRequest = ListConfigurationManagersRequest { }): Flow<ListConfigurationManagersResponse>

fun SsmQuickSetupClient.listConfigurationManagersPaginated(block: ListConfigurationManagersRequest.Builder.() -> Unit): Flow<ListConfigurationManagersResponse>

Paginate over ListConfigurationManagersResponse results.

listConfigurations

inline suspend fun SsmQuickSetupClient.listConfigurations(crossinline block: ListConfigurationsRequest.Builder.() -> Unit): ListConfigurationsResponse

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

listConfigurationsPaginated

fun SsmQuickSetupClient.listConfigurationsPaginated(initialRequest: ListConfigurationsRequest = ListConfigurationsRequest { }): Flow<ListConfigurationsResponse>

fun SsmQuickSetupClient.listConfigurationsPaginated(block: ListConfigurationsRequest.Builder.() -> Unit): Flow<ListConfigurationsResponse>

Paginate over ListConfigurationsResponse results.

listQuickSetupTypes

inline suspend fun SsmQuickSetupClient.listQuickSetupTypes(crossinline block: ListQuickSetupTypesRequest.Builder.() -> Unit): ListQuickSetupTypesResponse

Returns the available Quick Setup types.

listTagsForResource

inline suspend fun SsmQuickSetupClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns tags assigned to the resource.

tagResource

inline suspend fun SsmQuickSetupClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns key-value pairs of metadata to Amazon Web Services resources.

untagResource

inline suspend fun SsmQuickSetupClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the specified resource.

updateConfigurationDefinition

inline suspend fun SsmQuickSetupClient.updateConfigurationDefinition(crossinline block: UpdateConfigurationDefinitionRequest.Builder.() -> Unit): UpdateConfigurationDefinitionResponse

Updates a Quick Setup configuration definition.

updateConfigurationManager

inline suspend fun SsmQuickSetupClient.updateConfigurationManager(crossinline block: UpdateConfigurationManagerRequest.Builder.() -> Unit): UpdateConfigurationManagerResponse

Updates a Quick Setup configuration manager.

updateServiceSettings

inline suspend fun SsmQuickSetupClient.updateServiceSettings(crossinline block: UpdateServiceSettingsRequest.Builder.() -> Unit): UpdateServiceSettingsResponse

Updates settings configured for Quick Setup.

withConfig

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

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.