Package software.amazon.awssdk.services.costoptimizationhub

Interface CostOptimizationHubClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CostOptimizationHubClient
extends AwsClient

Service client for accessing Cost Optimization Hub. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CostOptimizationHubClientBuilder	builder()	Create a builder that can be used to configure and create a CostOptimizationHubClient.
static CostOptimizationHubClient	create()	Create a CostOptimizationHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetPreferencesResponse	getPreferences(Consumer<GetPreferencesRequest.Builder> getPreferencesRequest)	Returns a set of preferences for an account in order to add account-specific preferences into the service.
default GetPreferencesResponse	getPreferences(GetPreferencesRequest getPreferencesRequest)	Returns a set of preferences for an account in order to add account-specific preferences into the service.
default GetRecommendationResponse	getRecommendation(Consumer<GetRecommendationRequest.Builder> getRecommendationRequest)	Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
default GetRecommendationResponse	getRecommendation(GetRecommendationRequest getRecommendationRequest)	Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
default ListEnrollmentStatusesResponse	listEnrollmentStatuses(Consumer<ListEnrollmentStatusesRequest.Builder> listEnrollmentStatusesRequest)	Retrieves the enrollment status for an account.
default ListEnrollmentStatusesResponse	listEnrollmentStatuses(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)	Retrieves the enrollment status for an account.
default ListEnrollmentStatusesIterable	listEnrollmentStatusesPaginator(Consumer<ListEnrollmentStatusesRequest.Builder> listEnrollmentStatusesRequest)	This is a variant of listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation.
default ListEnrollmentStatusesIterable	listEnrollmentStatusesPaginator(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)	This is a variant of listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation.
default ListRecommendationsResponse	listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)	Returns a list of recommendations.
default ListRecommendationsResponse	listRecommendations(ListRecommendationsRequest listRecommendationsRequest)	Returns a list of recommendations.
default ListRecommendationsIterable	listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)	This is a variant of listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation.
default ListRecommendationsIterable	listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest)	This is a variant of listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation.
default ListRecommendationSummariesResponse	listRecommendationSummaries(Consumer<ListRecommendationSummariesRequest.Builder> listRecommendationSummariesRequest)	Returns a concise representation of savings estimates for resources.
default ListRecommendationSummariesResponse	listRecommendationSummaries(ListRecommendationSummariesRequest listRecommendationSummariesRequest)	Returns a concise representation of savings estimates for resources.
default ListRecommendationSummariesIterable	listRecommendationSummariesPaginator(Consumer<ListRecommendationSummariesRequest.Builder> listRecommendationSummariesRequest)	This is a variant of listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation.
default ListRecommendationSummariesIterable	listRecommendationSummariesPaginator(ListRecommendationSummariesRequest listRecommendationSummariesRequest)	This is a variant of listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation.
default CostOptimizationHubServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default UpdateEnrollmentStatusResponse	updateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest)	Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
default UpdateEnrollmentStatusResponse	updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)	Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
default UpdatePreferencesResponse	updatePreferences(Consumer<UpdatePreferencesRequest.Builder> updatePreferencesRequest)	Updates a set of preferences for an account in order to add account-specific preferences into the service.
default UpdatePreferencesResponse	updatePreferences(UpdatePreferencesRequest updatePreferencesRequest)	Updates a set of preferences for an account in order to add account-specific preferences into the service.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

getPreferences

default GetPreferencesResponse getPreferences(GetPreferencesRequest getPreferencesRequest)
                                       throws ValidationException,
                                              InternalServerException,
                                              AccessDeniedException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              CostOptimizationHubException

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.

Parameters:

getPreferencesRequest -

Returns:

Result of the GetPreferences operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPreferences

default GetPreferencesResponse getPreferences(Consumer<GetPreferencesRequest.Builder> getPreferencesRequest)
                                       throws ValidationException,
                                              InternalServerException,
                                              AccessDeniedException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              CostOptimizationHubException

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.

This is a convenience which creates an instance of the GetPreferencesRequest.Builder avoiding the need to create one manually via GetPreferencesRequest.builder()

Parameters:

getPreferencesRequest - A Consumer that will call methods on GetPreferencesRequest.Builder to create a request.

Returns:

Result of the GetPreferences operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRecommendation

default GetRecommendationResponse getRecommendation(GetRecommendationRequest getRecommendationRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CostOptimizationHubException

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

The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.

Parameters:

getRecommendationRequest -

Returns:

Result of the GetRecommendation operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRecommendation

default GetRecommendationResponse getRecommendation(Consumer<GetRecommendationRequest.Builder> getRecommendationRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CostOptimizationHubException

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

The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.

This is a convenience which creates an instance of the GetRecommendationRequest.Builder avoiding the need to create one manually via GetRecommendationRequest.builder()

Parameters:

getRecommendationRequest - A Consumer that will call methods on GetRecommendationRequest.Builder to create a request.

Returns:

Result of the GetRecommendation operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnrollmentStatuses

default ListEnrollmentStatusesResponse listEnrollmentStatuses(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)
                                                       throws ValidationException,
                                                              InternalServerException,
                                                              AccessDeniedException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CostOptimizationHubException

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

Parameters:

listEnrollmentStatusesRequest -

Returns:

Result of the ListEnrollmentStatuses operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnrollmentStatuses

default ListEnrollmentStatusesResponse listEnrollmentStatuses(Consumer<ListEnrollmentStatusesRequest.Builder> listEnrollmentStatusesRequest)
                                                       throws ValidationException,
                                                              InternalServerException,
                                                              AccessDeniedException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CostOptimizationHubException

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

This is a convenience which creates an instance of the ListEnrollmentStatusesRequest.Builder avoiding the need to create one manually via ListEnrollmentStatusesRequest.builder()

Parameters:

listEnrollmentStatusesRequest - A Consumer that will call methods on ListEnrollmentStatusesRequest.Builder to create a request.

Returns:

Result of the ListEnrollmentStatuses operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnrollmentStatusesPaginator

default ListEnrollmentStatusesIterable listEnrollmentStatusesPaginator(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)
                                                                throws ValidationException,
                                                                       InternalServerException,
                                                                       AccessDeniedException,
                                                                       ThrottlingException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       CostOptimizationHubException

This is a variant of listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client.listEnrollmentStatusesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client
             .listEnrollmentStatusesPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client.listEnrollmentStatusesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation.

Parameters:

listEnrollmentStatusesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnrollmentStatusesPaginator

default ListEnrollmentStatusesIterable listEnrollmentStatusesPaginator(Consumer<ListEnrollmentStatusesRequest.Builder> listEnrollmentStatusesRequest)
                                                                throws ValidationException,
                                                                       InternalServerException,
                                                                       AccessDeniedException,
                                                                       ThrottlingException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       CostOptimizationHubException

This is a variant of listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client.listEnrollmentStatusesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client
             .listEnrollmentStatusesPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListEnrollmentStatusesIterable responses = client.listEnrollmentStatusesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnrollmentStatuses(software.amazon.awssdk.services.costoptimizationhub.model.ListEnrollmentStatusesRequest) operation.

This is a convenience which creates an instance of the ListEnrollmentStatusesRequest.Builder avoiding the need to create one manually via ListEnrollmentStatusesRequest.builder()

Parameters:

listEnrollmentStatusesRequest - A Consumer that will call methods on ListEnrollmentStatusesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationSummaries

default ListRecommendationSummariesResponse listRecommendationSummaries(ListRecommendationSummariesRequest listRecommendationSummariesRequest)
                                                                 throws ValidationException,
                                                                        InternalServerException,
                                                                        AccessDeniedException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        CostOptimizationHubException

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

The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.

Parameters:

listRecommendationSummariesRequest -

Returns:

Result of the ListRecommendationSummaries operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationSummaries

default ListRecommendationSummariesResponse listRecommendationSummaries(Consumer<ListRecommendationSummariesRequest.Builder> listRecommendationSummariesRequest)
                                                                 throws ValidationException,
                                                                        InternalServerException,
                                                                        AccessDeniedException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        CostOptimizationHubException

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

The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.

This is a convenience which creates an instance of the ListRecommendationSummariesRequest.Builder avoiding the need to create one manually via ListRecommendationSummariesRequest.builder()

Parameters:

listRecommendationSummariesRequest - A Consumer that will call methods on ListRecommendationSummariesRequest.Builder to create a request.

Returns:

Result of the ListRecommendationSummaries operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationSummariesPaginator

default ListRecommendationSummariesIterable listRecommendationSummariesPaginator(ListRecommendationSummariesRequest listRecommendationSummariesRequest)
                                                                          throws ValidationException,
                                                                                 InternalServerException,
                                                                                 AccessDeniedException,
                                                                                 ThrottlingException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 CostOptimizationHubException

This is a variant of listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client.listRecommendationSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client
             .listRecommendationSummariesPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client.listRecommendationSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation.

Parameters:

listRecommendationSummariesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationSummariesPaginator

default ListRecommendationSummariesIterable listRecommendationSummariesPaginator(Consumer<ListRecommendationSummariesRequest.Builder> listRecommendationSummariesRequest)
                                                                          throws ValidationException,
                                                                                 InternalServerException,
                                                                                 AccessDeniedException,
                                                                                 ThrottlingException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 CostOptimizationHubException

This is a variant of listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client.listRecommendationSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client
             .listRecommendationSummariesPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationSummariesIterable responses = client.listRecommendationSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecommendationSummaries(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest) operation.

This is a convenience which creates an instance of the ListRecommendationSummariesRequest.Builder avoiding the need to create one manually via ListRecommendationSummariesRequest.builder()

Parameters:

listRecommendationSummariesRequest - A Consumer that will call methods on ListRecommendationSummariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendations

default ListRecommendationsResponse listRecommendations(ListRecommendationsRequest listRecommendationsRequest)
                                                 throws ValidationException,
                                                        InternalServerException,
                                                        AccessDeniedException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        CostOptimizationHubException

Returns a list of recommendations.

Parameters:

listRecommendationsRequest -

Returns:

Result of the ListRecommendations operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendations

default ListRecommendationsResponse listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)
                                                 throws ValidationException,
                                                        InternalServerException,
                                                        AccessDeniedException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        CostOptimizationHubException

Returns a list of recommendations.

This is a convenience which creates an instance of the ListRecommendationsRequest.Builder avoiding the need to create one manually via ListRecommendationsRequest.builder()

Parameters:

listRecommendationsRequest - A Consumer that will call methods on ListRecommendationsRequest.Builder to create a request.

Returns:

Result of the ListRecommendations operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationsPaginator

default ListRecommendationsIterable listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest)
                                                          throws ValidationException,
                                                                 InternalServerException,
                                                                 AccessDeniedException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 CostOptimizationHubException

This is a variant of listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client
             .listRecommendationsPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation.

Parameters:

listRecommendationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRecommendationsPaginator

default ListRecommendationsIterable listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)
                                                          throws ValidationException,
                                                                 InternalServerException,
                                                                 AccessDeniedException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 CostOptimizationHubException

This is a variant of listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client
             .listRecommendationsPaginator(request);
     for (software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.costoptimizationhub.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecommendations(software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationsRequest) operation.

This is a convenience which creates an instance of the ListRecommendationsRequest.Builder avoiding the need to create one manually via ListRecommendationsRequest.builder()

Parameters:

listRecommendationsRequest - A Consumer that will call methods on ListRecommendationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEnrollmentStatus

default UpdateEnrollmentStatusResponse updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)
                                                       throws ValidationException,
                                                              InternalServerException,
                                                              AccessDeniedException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CostOptimizationHubException

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

If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.

You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.

Parameters:

updateEnrollmentStatusRequest -

Returns:

Result of the UpdateEnrollmentStatus operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEnrollmentStatus

default UpdateEnrollmentStatusResponse updateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest)
                                                       throws ValidationException,
                                                              InternalServerException,
                                                              AccessDeniedException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CostOptimizationHubException

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

If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.

You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.

This is a convenience which creates an instance of the UpdateEnrollmentStatusRequest.Builder avoiding the need to create one manually via UpdateEnrollmentStatusRequest.builder()

Parameters:

updateEnrollmentStatusRequest - A Consumer that will call methods on UpdateEnrollmentStatusRequest.Builder to create a request.

Returns:

Result of the UpdateEnrollmentStatus operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePreferences

default UpdatePreferencesResponse updatePreferences(UpdatePreferencesRequest updatePreferencesRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CostOptimizationHubException

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.

Parameters:

updatePreferencesRequest -

Returns:

Result of the UpdatePreferences operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePreferences

default UpdatePreferencesResponse updatePreferences(Consumer<UpdatePreferencesRequest.Builder> updatePreferencesRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CostOptimizationHubException

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.

This is a convenience which creates an instance of the UpdatePreferencesRequest.Builder avoiding the need to create one manually via UpdatePreferencesRequest.builder()

Parameters:

updatePreferencesRequest - A Consumer that will call methods on UpdatePreferencesRequest.Builder to create a request.

Returns:

Result of the UpdatePreferences operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - An error on the server occurred during the processing of your request. Try again later.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CostOptimizationHubException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static CostOptimizationHubClient create()

Create a CostOptimizationHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CostOptimizationHubClientBuilder builder()

Create a builder that can be used to configure and create a CostOptimizationHubClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CostOptimizationHubServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient