costoptimizationhub/aws.sdk.kotlin.services.costoptimizationhub/CostOptimizationHubClient

CostOptimizationHubClient

interface CostOptimizationHubClient : SdkClient

You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.

The Cost Optimization Hub API provides the following endpoint:

https://cost-optimization-hub.us-east-1.amazonaws.com

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: CostOptimizationHubClient.Config

CostOptimizationHubClient's configuration

Functions

getPreferences

abstract suspend fun getPreferences(input: GetPreferencesRequest = GetPreferencesRequest { }): GetPreferencesResponse

Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.

getRecommendation

abstract suspend fun getRecommendation(input: GetRecommendationRequest): GetRecommendationResponse

Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.

listEnrollmentStatuses

abstract suspend fun listEnrollmentStatuses(input: ListEnrollmentStatusesRequest = ListEnrollmentStatusesRequest { }): ListEnrollmentStatusesResponse

Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.

listRecommendations

abstract suspend fun listRecommendations(input: ListRecommendationsRequest = ListRecommendationsRequest { }): ListRecommendationsResponse

Returns a list of recommendations.

listRecommendationSummaries

abstract suspend fun listRecommendationSummaries(input: ListRecommendationSummariesRequest): ListRecommendationSummariesResponse

Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.

updateEnrollmentStatus

abstract suspend fun updateEnrollmentStatus(input: UpdateEnrollmentStatusRequest): UpdateEnrollmentStatusResponse

Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.

updatePreferences

abstract suspend fun updatePreferences(input: UpdatePreferencesRequest = UpdatePreferencesRequest { }): UpdatePreferencesResponse

Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.

Inherited functions

expect abstract fun close()

getPreferences

inline suspend fun CostOptimizationHubClient.getPreferences(crossinline block: GetPreferencesRequest.Builder.() -> Unit): GetPreferencesResponse

getRecommendation

inline suspend fun CostOptimizationHubClient.getRecommendation(crossinline block: GetRecommendationRequest.Builder.() -> Unit): GetRecommendationResponse

Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.

listEnrollmentStatuses

inline suspend fun CostOptimizationHubClient.listEnrollmentStatuses(crossinline block: ListEnrollmentStatusesRequest.Builder.() -> Unit): ListEnrollmentStatusesResponse

Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.

listEnrollmentStatusesPaginated

fun CostOptimizationHubClient.listEnrollmentStatusesPaginated(initialRequest: ListEnrollmentStatusesRequest = ListEnrollmentStatusesRequest { }): Flow<ListEnrollmentStatusesResponse>

fun CostOptimizationHubClient.listEnrollmentStatusesPaginated(block: ListEnrollmentStatusesRequest.Builder.() -> Unit): Flow<ListEnrollmentStatusesResponse>

Paginate over ListEnrollmentStatusesResponse results.

listRecommendations

inline suspend fun CostOptimizationHubClient.listRecommendations(crossinline block: ListRecommendationsRequest.Builder.() -> Unit): ListRecommendationsResponse

Returns a list of recommendations.

listRecommendationsPaginated

fun CostOptimizationHubClient.listRecommendationsPaginated(initialRequest: ListRecommendationsRequest = ListRecommendationsRequest { }): Flow<ListRecommendationsResponse>

fun CostOptimizationHubClient.listRecommendationsPaginated(block: ListRecommendationsRequest.Builder.() -> Unit): Flow<ListRecommendationsResponse>

Paginate over ListRecommendationsResponse results.

listRecommendationSummaries

inline suspend fun CostOptimizationHubClient.listRecommendationSummaries(crossinline block: ListRecommendationSummariesRequest.Builder.() -> Unit): ListRecommendationSummariesResponse

Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.

listRecommendationSummariesPaginated

fun CostOptimizationHubClient.listRecommendationSummariesPaginated(initialRequest: ListRecommendationSummariesRequest): Flow<ListRecommendationSummariesResponse>

fun CostOptimizationHubClient.listRecommendationSummariesPaginated(block: ListRecommendationSummariesRequest.Builder.() -> Unit): Flow<ListRecommendationSummariesResponse>

Paginate over ListRecommendationSummariesResponse results.

updateEnrollmentStatus

inline suspend fun CostOptimizationHubClient.updateEnrollmentStatus(crossinline block: UpdateEnrollmentStatusRequest.Builder.() -> Unit): UpdateEnrollmentStatusResponse

Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.

updatePreferences

inline suspend fun CostOptimizationHubClient.updatePreferences(crossinline block: UpdatePreferencesRequest.Builder.() -> Unit): UpdatePreferencesResponse

Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.

withConfig

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

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.