marketplaceentitlementservice/aws.sdk.kotlin.services.marketplaceentitlementservice/MarketplaceEntitlementClient

MarketplaceEntitlementClient

interface MarketplaceEntitlementClient : SdkClient

AWS Marketplace Entitlement Service

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

Getting Entitlement Records

GetEntitlements- Gets the entitlements for a Marketplace product.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: MarketplaceEntitlementClient.Config

MarketplaceEntitlementClient's configuration

Functions

getEntitlements

abstract suspend fun getEntitlements(input: GetEntitlementsRequest): GetEntitlementsResponse

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

Inherited functions

expect abstract fun close()

getEntitlements

inline suspend fun MarketplaceEntitlementClient.getEntitlements(crossinline block: GetEntitlementsRequest.Builder.() -> Unit): GetEntitlementsResponse

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

getEntitlementsPaginated

fun MarketplaceEntitlementClient.getEntitlementsPaginated(initialRequest: GetEntitlementsRequest): Flow<GetEntitlementsResponse>

fun MarketplaceEntitlementClient.getEntitlementsPaginated(block: GetEntitlementsRequest.Builder.() -> Unit): Flow<GetEntitlementsResponse>

Paginate over GetEntitlementsResponse results.

withConfig

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

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.