Package software.amazon.awssdk.services.freetier

Interface FreeTierClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Free Tier. This can be created using the static builder() method.

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:

• https://freetier.us-east-1.api.aws

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

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 FreeTierClientBuilder	builder()	Create a builder that can be used to configure and create a FreeTierClient.
static FreeTierClient	create()	Create a FreeTierClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetFreeTierUsageResponse	getFreeTierUsage(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest)	Returns a list of all Free Tier usage objects that match your filters.
default GetFreeTierUsageResponse	getFreeTierUsage(GetFreeTierUsageRequest getFreeTierUsageRequest)	Returns a list of all Free Tier usage objects that match your filters.
default GetFreeTierUsageIterable	getFreeTierUsagePaginator(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest)	This is a variant of getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) operation.
default GetFreeTierUsageIterable	getFreeTierUsagePaginator(GetFreeTierUsageRequest getFreeTierUsageRequest)	This is a variant of getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) operation.
default FreeTierServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

getFreeTierUsage

default GetFreeTierUsageResponse getFreeTierUsage(GetFreeTierUsageRequest getFreeTierUsageRequest)
                                           throws InternalServerException,
                                                  ValidationException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FreeTierException

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

Parameters:

getFreeTierUsageRequest -

Returns:

Result of the GetFreeTierUsage operation returned by the service.

Throws:

InternalServerException - An unexpected error occurred during the processing of your request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

getFreeTierUsage

default GetFreeTierUsageResponse getFreeTierUsage(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest)
                                           throws InternalServerException,
                                                  ValidationException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FreeTierException

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

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

Parameters:

getFreeTierUsageRequest - A Consumer that will call methods on GetFreeTierUsageRequest.Builder to create a request.

Returns:

Result of the GetFreeTierUsage operation returned by the service.

Throws:

InternalServerException - An unexpected error occurred during the processing of your request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

getFreeTierUsagePaginator

default GetFreeTierUsageIterable getFreeTierUsagePaginator(GetFreeTierUsageRequest getFreeTierUsageRequest)
                                                    throws InternalServerException,
                                                           ValidationException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           FreeTierException

This is a variant of getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) 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.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client
             .getFreeTierUsagePaginator(request);
     for (software.amazon.awssdk.services.freetier.model.GetFreeTierUsageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(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 getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) operation.

Parameters:

getFreeTierUsageRequest -

Returns:

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

Throws:

InternalServerException - An unexpected error occurred during the processing of your request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

getFreeTierUsagePaginator

default GetFreeTierUsageIterable getFreeTierUsagePaginator(Consumer<GetFreeTierUsageRequest.Builder> getFreeTierUsageRequest)
                                                    throws InternalServerException,
                                                           ValidationException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           FreeTierException

This is a variant of getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) 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.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client
             .getFreeTierUsagePaginator(request);
     for (software.amazon.awssdk.services.freetier.model.GetFreeTierUsageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.freetier.paginators.GetFreeTierUsageIterable responses = client.getFreeTierUsagePaginator(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 getFreeTierUsage(software.amazon.awssdk.services.freetier.model.GetFreeTierUsageRequest) operation.

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

Parameters:

getFreeTierUsageRequest - A Consumer that will call methods on GetFreeTierUsageRequest.Builder to create a request.

Returns:

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

Throws:

InternalServerException - An unexpected error occurred during the processing of your request.

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

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.

FreeTierException - 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 FreeTierClient create()

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

builder

static FreeTierClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default FreeTierServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient