licensemanagerusersubscriptions/aws.sdk.kotlin.services.licensemanagerusersubscriptions/LicenseManagerUserSubscriptionsClient

LicenseManagerUserSubscriptionsClient

interface LicenseManagerUserSubscriptionsClient : SdkClient

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Types

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

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

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

Properties

abstract override val config: LicenseManagerUserSubscriptionsClient.Config

LicenseManagerUserSubscriptionsClient's configuration

Functions

abstract suspend fun associateUser(input: AssociateUserRequest): AssociateUserResponse

Associates the user to an EC2 instance to utilize user-based subscriptions.

createLicenseServerEndpoint

abstract suspend fun createLicenseServerEndpoint(input: CreateLicenseServerEndpointRequest): CreateLicenseServerEndpointResponse

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

deleteLicenseServerEndpoint

abstract suspend fun deleteLicenseServerEndpoint(input: DeleteLicenseServerEndpointRequest): DeleteLicenseServerEndpointResponse

Deletes a LicenseServerEndpoint resource.

deregisterIdentityProvider

abstract suspend fun deregisterIdentityProvider(input: DeregisterIdentityProviderRequest = DeregisterIdentityProviderRequest { }): DeregisterIdentityProviderResponse

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

disassociateUser

abstract suspend fun disassociateUser(input: DisassociateUserRequest = DisassociateUserRequest { }): DisassociateUserResponse

Disassociates the user from an EC2 instance providing user-based subscriptions.

listIdentityProviders

abstract suspend fun listIdentityProviders(input: ListIdentityProvidersRequest = ListIdentityProvidersRequest { }): ListIdentityProvidersResponse

Lists the Active Directory identity providers for user-based subscriptions.

abstract suspend fun listInstances(input: ListInstancesRequest = ListInstancesRequest { }): ListInstancesResponse

Lists the EC2 instances providing user-based subscriptions.

listLicenseServerEndpoints

abstract suspend fun listLicenseServerEndpoints(input: ListLicenseServerEndpointsRequest = ListLicenseServerEndpointsRequest { }): ListLicenseServerEndpointsResponse

List the Remote Desktop Services (RDS) License Server endpoints

listProductSubscriptions

abstract suspend fun listProductSubscriptions(input: ListProductSubscriptionsRequest): ListProductSubscriptionsResponse

Lists the user-based subscription products available from an identity provider.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns the list of tags for the specified resource.

listUserAssociations

abstract suspend fun listUserAssociations(input: ListUserAssociationsRequest): ListUserAssociationsResponse

Lists user associations for an identity provider.

registerIdentityProvider

abstract suspend fun registerIdentityProvider(input: RegisterIdentityProviderRequest): RegisterIdentityProviderResponse

Registers an identity provider for user-based subscriptions.

startProductSubscription

abstract suspend fun startProductSubscription(input: StartProductSubscriptionRequest): StartProductSubscriptionResponse

Starts a product subscription for a user with the specified identity provider.

stopProductSubscription

abstract suspend fun stopProductSubscription(input: StopProductSubscriptionRequest = StopProductSubscriptionRequest { }): StopProductSubscriptionResponse

Stops a product subscription for a user with the specified identity provider.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to a resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from a resource.

updateIdentityProviderSettings

abstract suspend fun updateIdentityProviderSettings(input: UpdateIdentityProviderSettingsRequest): UpdateIdentityProviderSettingsResponse

Updates additional product configuration settings for the registered identity provider.

Inherited functions

inline suspend fun LicenseManagerUserSubscriptionsClient.associateUser(crossinline block: AssociateUserRequest.Builder.() -> Unit): AssociateUserResponse

Associates the user to an EC2 instance to utilize user-based subscriptions.

expect abstract fun close()

createLicenseServerEndpoint

inline suspend fun LicenseManagerUserSubscriptionsClient.createLicenseServerEndpoint(crossinline block: CreateLicenseServerEndpointRequest.Builder.() -> Unit): CreateLicenseServerEndpointResponse

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

deleteLicenseServerEndpoint

inline suspend fun LicenseManagerUserSubscriptionsClient.deleteLicenseServerEndpoint(crossinline block: DeleteLicenseServerEndpointRequest.Builder.() -> Unit): DeleteLicenseServerEndpointResponse

Deletes a LicenseServerEndpoint resource.

deregisterIdentityProvider

inline suspend fun LicenseManagerUserSubscriptionsClient.deregisterIdentityProvider(crossinline block: DeregisterIdentityProviderRequest.Builder.() -> Unit): DeregisterIdentityProviderResponse

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

disassociateUser

inline suspend fun LicenseManagerUserSubscriptionsClient.disassociateUser(crossinline block: DisassociateUserRequest.Builder.() -> Unit): DisassociateUserResponse

Disassociates the user from an EC2 instance providing user-based subscriptions.

listIdentityProviders

inline suspend fun LicenseManagerUserSubscriptionsClient.listIdentityProviders(crossinline block: ListIdentityProvidersRequest.Builder.() -> Unit): ListIdentityProvidersResponse

Lists the Active Directory identity providers for user-based subscriptions.

listIdentityProvidersPaginated

fun LicenseManagerUserSubscriptionsClient.listIdentityProvidersPaginated(initialRequest: ListIdentityProvidersRequest = ListIdentityProvidersRequest { }): Flow<ListIdentityProvidersResponse>

fun LicenseManagerUserSubscriptionsClient.listIdentityProvidersPaginated(block: ListIdentityProvidersRequest.Builder.() -> Unit): Flow<ListIdentityProvidersResponse>

Paginate over ListIdentityProvidersResponse results.

inline suspend fun LicenseManagerUserSubscriptionsClient.listInstances(crossinline block: ListInstancesRequest.Builder.() -> Unit): ListInstancesResponse

Lists the EC2 instances providing user-based subscriptions.

listInstancesPaginated

fun LicenseManagerUserSubscriptionsClient.listInstancesPaginated(initialRequest: ListInstancesRequest = ListInstancesRequest { }): Flow<ListInstancesResponse>

fun LicenseManagerUserSubscriptionsClient.listInstancesPaginated(block: ListInstancesRequest.Builder.() -> Unit): Flow<ListInstancesResponse>

Paginate over ListInstancesResponse results.

listLicenseServerEndpoints

inline suspend fun LicenseManagerUserSubscriptionsClient.listLicenseServerEndpoints(crossinline block: ListLicenseServerEndpointsRequest.Builder.() -> Unit): ListLicenseServerEndpointsResponse

List the Remote Desktop Services (RDS) License Server endpoints

listLicenseServerEndpointsPaginated

fun LicenseManagerUserSubscriptionsClient.listLicenseServerEndpointsPaginated(initialRequest: ListLicenseServerEndpointsRequest = ListLicenseServerEndpointsRequest { }): Flow<ListLicenseServerEndpointsResponse>

fun LicenseManagerUserSubscriptionsClient.listLicenseServerEndpointsPaginated(block: ListLicenseServerEndpointsRequest.Builder.() -> Unit): Flow<ListLicenseServerEndpointsResponse>

Paginate over ListLicenseServerEndpointsResponse results.

listProductSubscriptions

inline suspend fun LicenseManagerUserSubscriptionsClient.listProductSubscriptions(crossinline block: ListProductSubscriptionsRequest.Builder.() -> Unit): ListProductSubscriptionsResponse

Lists the user-based subscription products available from an identity provider.

listProductSubscriptionsPaginated

fun LicenseManagerUserSubscriptionsClient.listProductSubscriptionsPaginated(initialRequest: ListProductSubscriptionsRequest): Flow<ListProductSubscriptionsResponse>

fun LicenseManagerUserSubscriptionsClient.listProductSubscriptionsPaginated(block: ListProductSubscriptionsRequest.Builder.() -> Unit): Flow<ListProductSubscriptionsResponse>

Paginate over ListProductSubscriptionsResponse results.

listTagsForResource

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

Returns the list of tags for the specified resource.

listUserAssociations

inline suspend fun LicenseManagerUserSubscriptionsClient.listUserAssociations(crossinline block: ListUserAssociationsRequest.Builder.() -> Unit): ListUserAssociationsResponse

Lists user associations for an identity provider.

listUserAssociationsPaginated

fun LicenseManagerUserSubscriptionsClient.listUserAssociationsPaginated(initialRequest: ListUserAssociationsRequest): Flow<ListUserAssociationsResponse>

fun LicenseManagerUserSubscriptionsClient.listUserAssociationsPaginated(block: ListUserAssociationsRequest.Builder.() -> Unit): Flow<ListUserAssociationsResponse>

Paginate over ListUserAssociationsResponse results.

registerIdentityProvider

inline suspend fun LicenseManagerUserSubscriptionsClient.registerIdentityProvider(crossinline block: RegisterIdentityProviderRequest.Builder.() -> Unit): RegisterIdentityProviderResponse

Registers an identity provider for user-based subscriptions.

startProductSubscription

inline suspend fun LicenseManagerUserSubscriptionsClient.startProductSubscription(crossinline block: StartProductSubscriptionRequest.Builder.() -> Unit): StartProductSubscriptionResponse

Starts a product subscription for a user with the specified identity provider.

stopProductSubscription

inline suspend fun LicenseManagerUserSubscriptionsClient.stopProductSubscription(crossinline block: StopProductSubscriptionRequest.Builder.() -> Unit): StopProductSubscriptionResponse

Stops a product subscription for a user with the specified identity provider.

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

Adds tags to a resource.

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

Removes tags from a resource.

updateIdentityProviderSettings

inline suspend fun LicenseManagerUserSubscriptionsClient.updateIdentityProviderSettings(crossinline block: UpdateIdentityProviderSettingsRequest.Builder.() -> Unit): UpdateIdentityProviderSettingsResponse

Updates additional product configuration settings for the registered identity provider.

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

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.