freetier/aws.sdk.kotlin.services.freetier/FreeTierClient

FreeTierClient

You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.

Free Tier tracks your monthly usage data for all free tier offers that are associated with your Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.

Service endpoint

The Free Tier API provides the following endpoint:

For more information, see Using the Amazon Web Services Free Tier in the Billing User Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: FreeTierClient.Config

FreeTierClient's configuration

Functions

getAccountActivity

abstract suspend fun getAccountActivity(input: GetAccountActivityRequest): GetAccountActivityResponse

Returns a specific activity record that is available to the customer.

getAccountPlanState

abstract suspend fun getAccountPlanState(input: GetAccountPlanStateRequest = GetAccountPlanStateRequest { }): GetAccountPlanStateResponse

This returns all of the information related to the state of the account plan related to Free Tier.

getFreeTierUsage

abstract suspend fun getFreeTierUsage(input: GetFreeTierUsageRequest = GetFreeTierUsageRequest { }): GetFreeTierUsageResponse

Returns a list of all Free Tier usage objects that match your filters.

listAccountActivities

abstract suspend fun listAccountActivities(input: ListAccountActivitiesRequest = ListAccountActivitiesRequest { }): ListAccountActivitiesResponse

Returns a list of activities that are available. This operation supports pagination and filtering by status.

upgradeAccountPlan

abstract suspend fun upgradeAccountPlan(input: UpgradeAccountPlanRequest): UpgradeAccountPlanResponse

The account plan type for the Amazon Web Services account.

Inherited functions

expect abstract fun close()

getAccountActivity

inline suspend fun FreeTierClient.getAccountActivity(crossinline block: GetAccountActivityRequest.Builder.() -> Unit): GetAccountActivityResponse

Returns a specific activity record that is available to the customer.

getAccountPlanState

inline suspend fun FreeTierClient.getAccountPlanState(crossinline block: GetAccountPlanStateRequest.Builder.() -> Unit): GetAccountPlanStateResponse

This returns all of the information related to the state of the account plan related to Free Tier.

getFreeTierUsage

inline suspend fun FreeTierClient.getFreeTierUsage(crossinline block: GetFreeTierUsageRequest.Builder.() -> Unit): GetFreeTierUsageResponse

Returns a list of all Free Tier usage objects that match your filters.

getFreeTierUsagePaginated

fun FreeTierClient.getFreeTierUsagePaginated(initialRequest: GetFreeTierUsageRequest = GetFreeTierUsageRequest { }): Flow<GetFreeTierUsageResponse>

fun FreeTierClient.getFreeTierUsagePaginated(block: GetFreeTierUsageRequest.Builder.() -> Unit): Flow<GetFreeTierUsageResponse>

Paginate over GetFreeTierUsageResponse results.

listAccountActivities

inline suspend fun FreeTierClient.listAccountActivities(crossinline block: ListAccountActivitiesRequest.Builder.() -> Unit): ListAccountActivitiesResponse

Returns a list of activities that are available. This operation supports pagination and filtering by status.

listAccountActivitiesPaginated

fun FreeTierClient.listAccountActivitiesPaginated(initialRequest: ListAccountActivitiesRequest = ListAccountActivitiesRequest { }): Flow<ListAccountActivitiesResponse>

fun FreeTierClient.listAccountActivitiesPaginated(block: ListAccountActivitiesRequest.Builder.() -> Unit): Flow<ListAccountActivitiesResponse>

Paginate over ListAccountActivitiesResponse results.

upgradeAccountPlan

inline suspend fun FreeTierClient.upgradeAccountPlan(crossinline block: UpgradeAccountPlanRequest.Builder.() -> Unit): UpgradeAccountPlanResponse

The account plan type for the Amazon Web Services account.

withConfig

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

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.