pricingplanmanager/aws.sdk.kotlin.services.pricingplanmanager/PricingPlanManagerClient

PricingPlanManagerClient

interface PricingPlanManagerClient : SdkClient

Manages flat-rate pricing subscriptions for supported AWS services. Use this API to create, approve, update, and cancel subscriptions; associate and disassociate resources; and retrieve subscription details. With a flat-rate pricing subscription, you pay a fixed recurring fee for eligible resources instead of usage-based pricing.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: PricingPlanManagerClient.Config

PricingPlanManagerClient's configuration

Functions

approvePaidSubscription

abstract suspend fun approvePaidSubscription(input: ApprovePaidSubscriptionRequest): ApprovePaidSubscriptionResponse

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

associateResourcesToSubscription

abstract suspend fun associateResourcesToSubscription(input: AssociateResourcesToSubscriptionRequest): AssociateResourcesToSubscriptionResponse

Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

cancelSubscription

abstract suspend fun cancelSubscription(input: CancelSubscriptionRequest): CancelSubscriptionResponse

Cancels a flat-rate pricing subscription.

cancelSubscriptionChange

abstract suspend fun cancelSubscriptionChange(input: CancelSubscriptionChangeRequest): CancelSubscriptionChangeResponse

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

createSubscription

abstract suspend fun createSubscription(input: CreateSubscriptionRequest): CreateSubscriptionResponse

Creates a flat-rate pricing subscription for the specified resources.

disassociateResourcesFromSubscription

abstract suspend fun disassociateResourcesFromSubscription(input: DisassociateResourcesFromSubscriptionRequest): DisassociateResourcesFromSubscriptionResponse

Removes one or more resources from an existing subscription.

getSubscription

abstract suspend fun getSubscription(input: GetSubscriptionRequest): GetSubscriptionResponse

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

listSubscriptions

abstract suspend fun listSubscriptions(input: ListSubscriptionsRequest = ListSubscriptionsRequest { }): ListSubscriptionsResponse

Returns a summary of all flat-rate pricing subscriptions in the calling account.

updateSubscription

abstract suspend fun updateSubscription(input: UpdateSubscriptionRequest): UpdateSubscriptionResponse

Changes the plan tier of an existing subscription.

Inherited functions

approvePaidSubscription

inline suspend fun PricingPlanManagerClient.approvePaidSubscription(crossinline block: ApprovePaidSubscriptionRequest.Builder.() -> Unit): ApprovePaidSubscriptionResponse

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

associateResourcesToSubscription

inline suspend fun PricingPlanManagerClient.associateResourcesToSubscription(crossinline block: AssociateResourcesToSubscriptionRequest.Builder.() -> Unit): AssociateResourcesToSubscriptionResponse

Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

cancelSubscription

inline suspend fun PricingPlanManagerClient.cancelSubscription(crossinline block: CancelSubscriptionRequest.Builder.() -> Unit): CancelSubscriptionResponse

Cancels a flat-rate pricing subscription.

cancelSubscriptionChange

inline suspend fun PricingPlanManagerClient.cancelSubscriptionChange(crossinline block: CancelSubscriptionChangeRequest.Builder.() -> Unit): CancelSubscriptionChangeResponse

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

expect abstract fun close()

createSubscription

inline suspend fun PricingPlanManagerClient.createSubscription(crossinline block: CreateSubscriptionRequest.Builder.() -> Unit): CreateSubscriptionResponse

Creates a flat-rate pricing subscription for the specified resources.

disassociateResourcesFromSubscription

inline suspend fun PricingPlanManagerClient.disassociateResourcesFromSubscription(crossinline block: DisassociateResourcesFromSubscriptionRequest.Builder.() -> Unit): DisassociateResourcesFromSubscriptionResponse

Removes one or more resources from an existing subscription.

getSubscription

inline suspend fun PricingPlanManagerClient.getSubscription(crossinline block: GetSubscriptionRequest.Builder.() -> Unit): GetSubscriptionResponse

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

listSubscriptions

inline suspend fun PricingPlanManagerClient.listSubscriptions(crossinline block: ListSubscriptionsRequest.Builder.() -> Unit): ListSubscriptionsResponse

Returns a summary of all flat-rate pricing subscriptions in the calling account.

listSubscriptionsPaginated

fun PricingPlanManagerClient.listSubscriptionsPaginated(initialRequest: ListSubscriptionsRequest = ListSubscriptionsRequest { }): Flow<ListSubscriptionsResponse>

fun PricingPlanManagerClient.listSubscriptionsPaginated(block: ListSubscriptionsRequest.Builder.() -> Unit): Flow<ListSubscriptionsResponse>

Paginate over ListSubscriptionsResponse results.

updateSubscription

inline suspend fun PricingPlanManagerClient.updateSubscription(crossinline block: UpdateSubscriptionRequest.Builder.() -> Unit): UpdateSubscriptionResponse

Changes the plan tier of an existing subscription.

withConfig

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

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.