Interface BcmRecommendedActionsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Billing and Cost Management Recommended Actions. This can be created using the static builder() method.

You can use the Billing and Cost Management Recommended Actions API to programmatically query your best practices and recommendations to optimize your costs.

The Billing and Cost Management Recommended Actions API provides the following endpoint:

• https://bcm-recommended-actions.us-east-1.api.aws

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BcmRecommendedActionsClientBuilder	builder()	Create a builder that can be used to configure and create a BcmRecommendedActionsClient.
static BcmRecommendedActionsClient	create()	Create a BcmRecommendedActionsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListRecommendedActionsResponse	listRecommendedActions(Consumer<ListRecommendedActionsRequest.Builder> listRecommendedActionsRequest)	Returns a list of recommended actions that match the filter criteria.
default ListRecommendedActionsResponse	listRecommendedActions(ListRecommendedActionsRequest listRecommendedActionsRequest)	Returns a list of recommended actions that match the filter criteria.
default ListRecommendedActionsIterable	listRecommendedActionsPaginator(Consumer<ListRecommendedActionsRequest.Builder> listRecommendedActionsRequest)	This is a variant of listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) operation.
default ListRecommendedActionsIterable	listRecommendedActionsPaginator(ListRecommendedActionsRequest listRecommendedActionsRequest)	This is a variant of listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) operation.
default BcmRecommendedActionsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Details

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 Details

listRecommendedActions

default ListRecommendedActionsResponse listRecommendedActions(ListRecommendedActionsRequest listRecommendedActionsRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
BcmRecommendedActionsException

Returns a list of recommended actions that match the filter criteria.

Parameters:

listRecommendedActionsRequest -

Returns:

Result of the ListRecommendedActions operation returned by the service.

See Also:

• AWS API Documentation

listRecommendedActions

default ListRecommendedActionsResponse listRecommendedActions(Consumer<ListRecommendedActionsRequest.Builder> listRecommendedActionsRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
BcmRecommendedActionsException

Returns a list of recommended actions that match the filter criteria.

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

Parameters:

listRecommendedActionsRequest - A Consumer that will call methods on ListRecommendedActionsRequest.Builder to create a request.

Returns:

Result of the ListRecommendedActions operation returned by the service.

See Also:

• AWS API Documentation

listRecommendedActionsPaginator

default ListRecommendedActionsIterable listRecommendedActionsPaginator(ListRecommendedActionsRequest listRecommendedActionsRequest)
                                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
BcmRecommendedActionsException

This is a variant of listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) 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.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client.listRecommendedActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client
             .listRecommendedActionsPaginator(request);
     for (software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client.listRecommendedActionsPaginator(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 listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) operation.

Parameters:

listRecommendedActionsRequest -

Returns:

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

See Also:

• AWS API Documentation

listRecommendedActionsPaginator

default ListRecommendedActionsIterable listRecommendedActionsPaginator(Consumer<ListRecommendedActionsRequest.Builder> listRecommendedActionsRequest)
                                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
BcmRecommendedActionsException

This is a variant of listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) 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.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client.listRecommendedActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client
             .listRecommendedActionsPaginator(request);
     for (software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmrecommendedactions.paginators.ListRecommendedActionsIterable responses = client.listRecommendedActionsPaginator(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 listRecommendedActions(software.amazon.awssdk.services.bcmrecommendedactions.model.ListRecommendedActionsRequest) operation.

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

Parameters:

listRecommendedActionsRequest - A Consumer that will call methods on ListRecommendedActionsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

create

static BcmRecommendedActionsClient create()

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

builder

static BcmRecommendedActionsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BcmRecommendedActionsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration