pricing/aws.sdk.kotlin.services.pricing/PricingClient

PricingClient

The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:

Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

Use GetServices without a service code to retrieve the service codes for all Amazon Web Services services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS``volumeType.

For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: PricingClient.Config

PricingClient's configuration

Functions

describeServices

abstract suspend fun describeServices(input: DescribeServicesRequest = DescribeServicesRequest { }): DescribeServicesResponse

Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

getAttributeValues

abstract suspend fun getAttributeValues(input: GetAttributeValuesRequest): GetAttributeValuesResponse

Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide.

getPriceListFileUrl

abstract suspend fun getPriceListFileUrl(input: GetPriceListFileUrlRequest): GetPriceListFileUrlResponse

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

getProducts

abstract suspend fun getProducts(input: GetProductsRequest): GetProductsResponse

Returns a list of all products that match the filter criteria.

listPriceLists

abstract suspend fun listPriceLists(input: ListPriceListsRequest): ListPriceListsResponse

Inherited functions

expect abstract fun close()

describeServices

inline suspend fun PricingClient.describeServices(crossinline block: DescribeServicesRequest.Builder.() -> Unit): DescribeServicesResponse

describeServicesPaginated

fun PricingClient.describeServicesPaginated(initialRequest: DescribeServicesRequest = DescribeServicesRequest { }): Flow<DescribeServicesResponse>

fun PricingClient.describeServicesPaginated(block: DescribeServicesRequest.Builder.() -> Unit): Flow<DescribeServicesResponse>

Paginate over DescribeServicesResponse results.

getAttributeValues

inline suspend fun PricingClient.getAttributeValues(crossinline block: GetAttributeValuesRequest.Builder.() -> Unit): GetAttributeValuesResponse

getAttributeValuesPaginated

fun PricingClient.getAttributeValuesPaginated(initialRequest: GetAttributeValuesRequest): Flow<GetAttributeValuesResponse>

fun PricingClient.getAttributeValuesPaginated(block: GetAttributeValuesRequest.Builder.() -> Unit): Flow<GetAttributeValuesResponse>

Paginate over GetAttributeValuesResponse results.

getPriceListFileUrl

inline suspend fun PricingClient.getPriceListFileUrl(crossinline block: GetPriceListFileUrlRequest.Builder.() -> Unit): GetPriceListFileUrlResponse

getProducts

inline suspend fun PricingClient.getProducts(crossinline block: GetProductsRequest.Builder.() -> Unit): GetProductsResponse

Returns a list of all products that match the filter criteria.

getProductsPaginated

fun PricingClient.getProductsPaginated(initialRequest: GetProductsRequest): Flow<GetProductsResponse>

fun PricingClient.getProductsPaginated(block: GetProductsRequest.Builder.() -> Unit): Flow<GetProductsResponse>

Paginate over GetProductsResponse results.

listPriceLists

inline suspend fun PricingClient.listPriceLists(crossinline block: ListPriceListsRequest.Builder.() -> Unit): ListPriceListsResponse

listPriceListsPaginated

fun PricingClient.listPriceListsPaginated(initialRequest: ListPriceListsRequest): Flow<ListPriceListsResponse>

fun PricingClient.listPriceListsPaginated(block: ListPriceListsRequest.Builder.() -> Unit): Flow<ListPriceListsResponse>

Paginate over ListPriceListsResponse results.

withConfig

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

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.